generated from the-liberated-edge/wikijs
adds to definition of done
This commit is contained in:
parent
2e09798174
commit
374bbfc464
16
README.md
16
README.md
@ -99,20 +99,22 @@ list of requirements or checklist.
|
|||||||
1. Every change request is represented as a git pull request. Merging changes
|
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
|
directly in the `main` branch is prohibited and guarded by a branch protection
|
||||||
rule in our source control system.
|
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 <issue title>`.
|
issue number prefixes the pull request title, e.g. `i-1 <issue title>`.
|
||||||
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
|
been resolved. Merging without a code review approval is only acceptable
|
||||||
when reviewers are not available.
|
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
|
an approach resembling Test Driven Development for the sake of automated
|
||||||
regression testing and avoidance.
|
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.
|
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.
|
have been resolved.
|
||||||
7. YAML documents have been formated with `yamlfix`.
|
8. YAML documents have been formated with `yamlfix`.
|
||||||
8. User facing changes have been documented appropriately.
|
9. User facing changes have been documented appropriately.
|
||||||
|
|
||||||
## Development environment setup
|
## Development environment setup
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user