Clarify rules

This commit is contained in:
Nick Chambers 2022-08-13 03:44:56 -05:00
parent f3e3351182
commit 1e43b5c2b3
1 changed files with 13 additions and 5 deletions

View File

@ -7,12 +7,20 @@ than a commit where you can count the number of characters changed on one hand.
### 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.
- Regardless of the number of commits, the final result must be no more than
5 characters changed.
- The PR must be useful and enhance the repository in an obvious way. Just
removing a trailing space at the end of a line is not an enhancement.
- Regardless of the number of commits, the final result should be no more than
5 changed characters.
- The PR must be useful and enhance the program usage in an obvious way. This
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
only do it once.