File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change @@ -22,6 +22,8 @@ Protocol (OSP).
22
22
- [ Support] ( #support )
23
23
- [ Maintainer] ( #maintainer )
24
24
- [ Contributing] ( #contributing )
25
+ - [ Code style and formatting] ( #code-style-and-formatting )
26
+ - [ CMake formatting] ( #cmake-formatting )
25
27
- [ License] ( #license )
26
28
27
29
## Releases
@@ -82,6 +84,33 @@ request](https://github.com/greenbone/gvmd/pulls) on GitHub. Bigger changes need
82
84
to be discussed with the development team via the [ issues section at
83
85
GitHub] ( https://github.com/greenbone/gvmd/issues ) first.
84
86
87
+ ### Code style and formatting
88
+
89
+ Before creating a pull request, it is recommended to run the following command:
90
+
91
+ ``` sh
92
+ make format
93
+ ```
94
+
95
+ This reformats the new code to ensure that it follows the code style and
96
+ formatting guidelines.
97
+
98
+ ### CMake formatting
99
+
100
+ All CMake files are formatted using [ gersemi] ( https://github.com/BlankSpruce/gersemi ) .
101
+ To install gersemi on a Debian based system the following commands can be used:
102
+
103
+ ``` sh
104
+ sudo apt install pipx
105
+ pipx install gersemi
106
+ ```
107
+
108
+ To format all CMake files run the command:
109
+
110
+ ``` sh
111
+ gersemi -i cmake .
112
+ ```
113
+
85
114
## License
86
115
87
116
Copyright (C) 2009-2025 [ Greenbone AG] ( https://www.greenbone.net/ )
You can’t perform that action at this time.
0 commit comments