From 374bbfc464f3fcc8eb3eef290176fdf74cebfcc8 Mon Sep 17 00:00:00 2001 From: emo Date: Sun, 3 Dec 2023 02:22:16 +0100 Subject: [PATCH] adds to definition of done --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9bc260b..dcd0844 100644 --- a/README.md +++ b/README.md @@ -99,20 +99,22 @@ list of requirements or checklist. 1. Every change request is represented as a git pull request. Merging changes directly in the `main` branch is prohibited and guarded by a branch protection rule in our source control system. -2. Every git pull request has been linked to exactly one project issue. The +2. All commits as part of a feature branch have been squashed into a single +commit that has been merged in the `main` branch. +3. Every git pull request has been linked to exactly one project issue. The issue number prefixes the pull request title, e.g. `i-1 `. -3. The change has been thoroughly reviewed and all discovered issues have +4. The change has been thoroughly reviewed and all discovered issues have been resolved. Merging without a code review approval is only acceptable when reviewers are not available. -4. The change has been tested by Ansible Molecule scenarios. Our team adopted +5. The change has been tested by Ansible Molecule scenarios. Our team adopted an approach resembling Test Driven Development for the sake of automated regression testing and avoidance. -5. All automated tests have been passing successfully consistently. We have +6. All automated tests have been passing successfully consistently. We have zero tolerance on test flakiness. -6. Source code has been linted with `yamllint` and `ansible-lint`. Any issues +7. Source code has been linted with `yamllint` and `ansible-lint`. Any issues have been resolved. -7. YAML documents have been formated with `yamlfix`. -8. User facing changes have been documented appropriately. +8. YAML documents have been formated with `yamlfix`. +9. User facing changes have been documented appropriately. ## Development environment setup