Refer to KISS and Fowler for code

Signed-off-by: Fabian Deutsch <[email protected]>
dshchedr · Aug 25, 2023 · 8518728 · 8518728
1 parent a8387ff
commit 8518728
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -16,8 +16,9 @@ This checklist is not enforcing, but it's a reminder of items that could be rele
 Approvers are expected to review this list.
 
 - [ ] Design: A [design document](https://github.com/kubevirt/community/tree/main/design-proposals) was considered and is present (link) or not required
-- [ ] PR: The description will help future contributors
-- [ ] Maintenance: The [Boy Scout Rule](https://learning.oreilly.com/library/view/97-things-every/9780596809515/ch08.html) was considered and applied if needed
+- [ ] PR: The PR description is expressive enough and will help future contributors
+- [ ] Code: [Write code that humans can understand](https://en.wikiquote.org/wiki/Martin_Fowler#code-for-humans) and [Keep it simple](https://en.wikipedia.org/wiki/KISS_principle)
+- [ ] Refactor: The [Boy Scout Rule](https://learning.oreilly.com/library/view/97-things-every/9780596809515/ch08.html) was considered and applied if needed
 - [ ] Upgrade: Impact of this change on upgrade flows was considered and addressed if required
 - [ ] Testing: New code requires [new unit tests](https://github.com/kubevirt/kubevirt/blob/main/docs/reviewer-guide.md#when-is-a-pr-good-enough). New features require at least one e2e test. Bug fixes: It depends
 - [ ] Documentation: A [user-guide update](https://github.com/kubevirt/user-guide/) was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature / API change.

diff --git a/docs/reviewer-guide.md b/docs/reviewer-guide.md
@@ -121,5 +121,5 @@ The lowest bar for acceptable golang **coding standards** (anti-patterns, coding
 
 The lowest **testing bar** to pass:
 * New code requires new unit tests.
-* New features at least on e2e test (only the core case must be tested)
-* Bug fixes might require an update to existing or the creation of  new unit or e2e test
+* New features at least one e2e test (only the core case must be tested)
+* Bug fixes might require an update to existing or the creation of new unit or e2e test