Update development documentation (#1851)

FerretDB · Jan 23, 2023 · b77b7e8 · b77b7e8
1 parent cc7b47d
commit b77b7e8
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 14 deletions.
diff --git a/.github/ISSUE_TEMPLATE/chore.yml b/.github/ISSUE_TEMPLATE/chore.yml
@@ -29,9 +29,9 @@ body:
       label: Definition of Done
       description: What should be done to consider this issue done? List everything that applies.
       value: |
-        - unit tests added;
-        - integration tests added;
-        - compatibility tests added;
+        - all handlers updated;
+        - unit tests added/updated;
+        - integration/compatibility tests added/updated;
         - spot refactorings done;
         - user documentation updated;
         - something else?

diff --git a/.github/PROCESS.md b/.github/PROCESS.md
@@ -35,6 +35,7 @@ If the team thinks that the task is bigger than **L**, it should be decomposed i
 
 Unless the issue explicitly states otherwise, the following things are always in the scope:
 
+* All handlers.
 * Tests.
   See contributing documentation for general discussion about unit and integration tests.
 * Small spot refactorings.

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -16,14 +16,12 @@ Closes #{issue_number}.
     please follow CONTRIBUTING.md.
 -->
 
-* [ ] I added unit tests for new functionality or bug fixes.
-* [ ] I added integration tests for new functionality or bug fixes.
-* [ ] I added compatibility tests for new functionality or bug fixes.
+* [ ] I added/updated unit tests.
+* [ ] I added/updated integration/compatibility tests.
+* [ ] I added/updated comments and checked rendering.
 * [ ] I made spot refactorings.
 * [ ] I updated user documentation.
 * [ ] I ran `task all`, and it passed.
-* [ ] I added/updated comments for both exported and unexported top-level declarations (functions, types, etc).
-* [ ] I checked comments rendering with `task godocs`.
-* [ ] I ensured that the title is good enough for the changelog.
+* [ ] I ensured that PR title is good enough for the changelog.
 * [ ] (for maintainers only) I set Reviewers ([`@FerretDB/core`](https://github.com/orgs/FerretDB/teams/core)), Assignee, Labels, Project and project's Sprint fields.
 * [ ] I marked all done items in this checklist.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -203,11 +203,14 @@ Some of our idiosyncrasies:
 Before submitting a pull request, please make sure that:
 
 1. Tests are added for new functionality or fixed bugs.
-   Dot notations for existing and non-existent documents and arrays should be tested.
-2. `task all` passes.
-3. Comments are added or updated for all new and changed top-level declarations (functions, types, etc).
-   Both exported and unexported declarations should have comments.
-4. Comments are rendered correctly in the `task godocs` output.
+Typical test cases include:
+   * happy paths;
+   * dot notation for existing and non-existent paths.
+2. Comments are added or updated for all new or changed code.
+   Please add missing comments for all (both exported and unexported)
+   new and changed top-level declarations (functions, types, etc).
+3. Comments are rendered correctly in the `task godocs` output.
+4. `task all` passes.
 
 ## Contributing documentation