From 1e43b5c2b38686609c90e049e68863079d09a6c7 Mon Sep 17 00:00:00 2001 From: Nick Chambers Date: Sat, 13 Aug 2022 03:44:56 -0500 Subject: [PATCH] Clarify rules --- Readme.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/Readme.md b/Readme.md index 5339574..292833d 100644 --- a/Readme.md +++ b/Readme.md @@ -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.