Skip to content

Commit 98b5ad1

Browse files
committed
Update CONTRIBUTING.md
Trying to explain why any PR should have a`description`
1 parent 0bb0b7f commit 98b5ad1

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Here are a few suggestions to make it easier for you to contribute!
44

5+
### Describe your PR
6+
7+
Please add a description of your proposed code changes. It does not need to be an exhaustive essay, however a PR with no description or just a few words might not get accepted, simply because very basic information is missing.
8+
9+
A good description helps us to review and understand your proposed changes. For example, you could say a few words about
10+
* what you try to achieve (new feature, fixing a bug, refactoring, security enhancements, etc.)
11+
* how your code works (short technical summary - focus on important aspects that might not be obvious when reading the code)
12+
* testing you performed, known limitations, open ends you possibly could not solve.
13+
* any areas where you like to get help from an experienced maintainer (yes WLEDMM has become big 😉)
14+
515
### Code style
616

717
When in doubt, it is easiest to replicate the code style you find in the files you want to edit :)
@@ -79,4 +89,5 @@ Good:
7989

8090
There is no set character limit for a comment within a line,
8191
though as a rule of thumb you should wrap your comment if it exceeds the width of your editor window.
92+
8293
Inline comments are OK if they describe that line only and are not exceedingly wide.

0 commit comments

Comments
 (0)