1
- Contributing
2
- ============
3
-
4
- Code
5
- ----
1
+ # Contributing
6
2
7
3
Please read the [ standards document] ( doc/design/standards ) before
8
4
contributing.
9
5
6
+ - [ Contributing] ( #contributing )
7
+ - [ Code] ( #code )
8
+ - [ Development] ( #development )
9
+ - [ Using AStyle] ( #using-astyle )
10
+ - [ Linting] ( #linting )
11
+ - [ Commit Styling] ( #commit-styling )
12
+ - [ Pull Requests] ( #pull-requests )
13
+ - [ Issues] ( #issues )
14
+
15
+ ---
16
+
17
+ ## Code
18
+
10
19
### Development
11
20
12
21
Make new branches for features ` git checkout -b my_feature ` and commit often
@@ -16,16 +25,15 @@ you have something that works.
16
25
#### Using AStyle
17
26
18
27
We have started using astyle to format the code. Please see
19
- http://astyle.sourceforge.net/ . There is a style file in the root directory
20
- of Aether, called .astylerc. To run this, do:
28
+ < http://astyle.sourceforge.net/ > . There is a style file in the root directory of
29
+ Aether, called .astylerc. To run this, do:
21
30
22
31
AStyle --project=.astylerc src/* .cpp
23
32
24
33
on WSL with Ubuntu, the command seems to be:
25
34
26
35
astyle --options=.astylerc src/* .cpp
27
36
28
-
29
37
#### Linting
30
38
31
39
For * C++* code make sure to use a static code checker like
@@ -44,13 +52,13 @@ python3 -m pip cpplint
44
52
python3 -m pip --user cpplint
45
53
```
46
54
47
- Using a linter in an editor is a good supplement, but not a replacement for the static linters.
48
- The linter in the 'atom' editor requires that you install the ` linter ` and ` gcc-linter ` packages.
49
- Atom also has additional packages ` whitespaces ` and ` tabs-to-spaces `
50
- to automatically remove whitespaces at the end of the lines, and
51
- convert tabs to spaces.
55
+ Using a linter in an editor is a good supplement, but not a replacement for the
56
+ static linters. The linter in the 'atom' editor requires that you install the
57
+ ` linter ` and ` gcc-linter ` packages. Atom also has additional packages
58
+ ` whitespaces ` and ` tabs-to-spaces ` to automatically remove whitespaces at the
59
+ end of the lines, and convert tabs to spaces.
52
60
53
- ### Commit Styling
61
+ ## Commit Styling
54
62
55
63
The first line of the commit must be * at most* ~ 50 characters long and
56
64
should start with either.
@@ -74,25 +82,24 @@ For example,
74
82
75
83
* do:*
76
84
77
- ```
85
+ ``` github
78
86
FEAT: Hydrostatic density implementation.
79
87
```
80
88
81
89
* don't:*
82
90
83
- ```
91
+ ``` github
84
92
Implemented hydrostatic density. (feature)
85
93
```
86
94
87
- ### Pull Requests
95
+ ## Pull Requests
88
96
89
97
Make sure you have linted and checked your code before asking for a
90
98
pull request. Before requesting a review, ensure the pull request
91
99
check list has been completed. Another member must check the code and
92
100
approve it before merge.
93
101
94
- Issues
95
- ------
102
+ ## Issues
96
103
97
104
* Issues* are reporting bugs, feature requests, or goals for the
98
105
project. In order to submit an issue make sure it follows the [ issue
0 commit comments