Skip to content

Commit cce5e8f

Browse files
committed
Update CONTRIBUTING.md - adding a hint to avoid force-pushing
1 parent 3a5eb8c commit cce5e8f

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@ A good description helps us to review and understand your proposed changes. For
1616

1717
Please make all PRs against the `0_15` branch.
1818

19+
### Updating your code
20+
While the PR is open - and under review by maintainers - you may be asked to modify your PR source code.
21+
You can simply update your own branch, and push changes in response to reviewer recommendations.
22+
Github will pick up the changes so your PR stays up-to-date.
23+
24+
> [!CAUTION]
25+
> Do not use "force-push" while your PR is open!
26+
> It has many subtle and unexpected consequences on our github reposistory.
27+
> For example, we regularly lost review comments when the PR author force-pushes code changes. So, pretty please, do not force-push.
28+
29+
30+
You kan find a collection of very usefull tips and tricks here: https://github.com/Aircoookie/WLED/wiki/How-to-properly-submit-a-PR
31+
32+
1933
### Code style
2034

2135
When in doubt, it is easiest to replicate the code style you find in the files you want to edit :)
@@ -37,16 +51,18 @@ if (a == b) {
3751
}
3852
```
3953

54+
```cpp
55+
if (a == b) doStuff(a);
56+
```
57+
58+
Acceptable - however the first variant is usually easier to read:
4059
```cpp
4160
if (a == b)
4261
{
4362
doStuff(a);
4463
}
4564
```
4665

47-
```cpp
48-
if (a == b) doStuff(a);
49-
```
5066

5167
There should always be a space between a keyword and its condition and between the condition and brace.
5268
Within the condition, no space should be between the parenthesis and variables.

0 commit comments

Comments
 (0)