@@ -31,6 +31,27 @@ If you are just beginning to work with RIOT you might first want to read our
31
31
32
32
[ documentation ] : https://doc.riot-os.org
33
33
34
+ ## General Tips
35
+ [ general-tips ] : #general-tips
36
+ From experience, the following recommendations help to get a software
37
+ contribution into RIOT master faster:
38
+
39
+ - ** Ask around for help!** Either offline or through one of our communication
40
+ channels (see above). The earlier you check your feature design with other
41
+ people, the less likely it is that it is denied during the review process.
42
+ - ** Verify your concept early!** If you work on your own until the code
43
+ * looks* good enough to show publicly, you might miss some design flaws others
44
+ might have spotted earlier.
45
+ - ** Keep it simple!** Try to use what is already there and don't change existing
46
+ APIs if not absolutely necessary.
47
+ - ** Keep it small!** A PR with >1000 lines of changes will very likely make
48
+ even the most active reviewer put your review on their long to-do list.
49
+ - ** Keep it modular!** Make extensions to a feature or new features for a
50
+ platform optionally to use.
51
+ - ** Provide tests!** They should be comprehensible and easy to be executed.
52
+ Alternatively comprehensive testing procedures should be provided with your
53
+ pull request.
54
+
34
55
## Help Wanted
35
56
[ help-wanted ] : #help-wanted
36
57
In case you're not really sure where to start, we've created a list of suggestions.
@@ -96,27 +117,6 @@ and got no response.
96
117
[ labels ] : https://github.com/RIOT-OS/RIOT/wiki/RIOT%27s-labeling-system
97
118
[ open-a-pull-request ] : https://help.github.com/articles/using-pull-requests
98
119
99
- ## General Tips
100
- [ general-tips ] : #general-tips
101
- From experience, the following recommendations help to get a software
102
- contribution into RIOT master faster:
103
-
104
- - ** Ask around for help!** Either offline or through one of our communication
105
- channels (see above). The earlier you check your feature design with other
106
- people, the less likely it is that it is denied during the review process.
107
- - ** Verify your concept early!** If you work on your own until the code
108
- * looks* good enough to show publicly, you might miss some design flaws others
109
- might have spotted earlier.
110
- - ** Keep it simple!** Try to use what is already there and don't change existing
111
- APIs if not absolutely necessary.
112
- - ** Keep it small!** A PR with >1000 lines of changes will very likely make
113
- even the most active reviewer put your review on their long to-do list.
114
- - ** Opt-in is better than mandatory!** Make extensions to a feature or new
115
- features for a platform optionally to use.
116
- - ** Provide tests!** They should be comprehensible and easy to be executed.
117
- Alternatively comprehensive testing procedures should be provided with your
118
- pull request.
119
-
120
120
## Feature Requests
121
121
[ feature-requests ] : #feature-requests
122
122
0 commit comments