Clarify rules
This commit is contained in:
parent
f3e3351182
commit
1e43b5c2b3
18
Readme.md
18
Readme.md
|
@ -7,12 +7,20 @@ than a commit where you can count the number of characters changed on one hand.
|
||||||
|
|
||||||
### Rules
|
### Rules
|
||||||
|
|
||||||
- All entries must be a PR.
|
- All entries must be a PR or equivalent.
|
||||||
- The PR should have as few commits as possible, ideally 1.
|
- The PR should have as few commits as possible, ideally 1.
|
||||||
- Regardless of the number of commits, the final result must be no more than
|
- Regardless of the number of commits, the final result should be no more than
|
||||||
5 characters changed.
|
5 changed characters.
|
||||||
- The PR must be useful and enhance the repository in an obvious way. Just
|
- The PR must be useful and enhance the program usage in an obvious way. This
|
||||||
removing a trailing space at the end of a line is not an enhancement.
|
includes but is not limited to:
|
||||||
|
* Fixing examples in documentation so they run correctly.
|
||||||
|
* Fixing a typo in actual code so it acts appropriately.
|
||||||
|
* Fixing wording in documentation that correctly changes the meaning of the
|
||||||
|
sentence.
|
||||||
|
- Some examples of what doesn't count:
|
||||||
|
* Removing a trailing space from the end of a line.
|
||||||
|
* [Fixing a typo in documentation that does not change the meaning.](https://github.com/netdata/netdata/pull/13514)
|
||||||
|
+ Such commits are important and should be made, but they are cosmetic.
|
||||||
- If the change needs to occur multiple times in a file, it is cheating to
|
- If the change needs to occur multiple times in a file, it is cheating to
|
||||||
only do it once.
|
only do it once.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue