docs: Add check and docs for regression tests

elastisys · Oct 19, 2023 · c52de8e · c52de8e
1 parent b9f72ce
commit c52de8e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -102,3 +102,5 @@
 - Audit checks:
  - [ ] The change does not cause any unnecessary Kubernetes audit events
  - [ ] The change requires changes to Kubernetes audit policy
+- Bug checks:
+ - [ ] The bug fix is covered by regression tests
diff --git a/tests/README.md b/tests/README.md
@@ -170,3 +170,10 @@ The format is recursive and keeps variables set for one test as it goes deeper i
 Any `clusters`, `namespaces` and `function` fields overwrites the previously set variable, while `condition` fields are accumulative.
 Any `target` field will case tests to be emitted for each cluster and namespace combo, skipping the `tests` fields in the same spec.
 Arguments starting with a `.` are treated as an expression and evaluated during runtime against the config.
+
+## Regression tests
+
+Whenever a bug is fixed there should be an associated regression test written to ensure that the bug will not resurface.
+
+Add them into `tests/regression` with the name format `<issue-or-pr-number>-<short-description>`.
+Use issue number if it exists in this repository, else use PR number.