the-liberated-edge/test_linux_containers
2
0
Fork 0
generated from the-liberated-edge/wikijs
Code Issues 5 Pull Requests Packages Projects 1 Releases Wiki Activity

improve readability and accurracy of definion of done

Browse Source
This commit is contained in:
emo 2023-12-03 02:55:33 +01:00
parent 374bbfc464
commit 613d457a47
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -102,18 +102,18 @@ rule in our source control system.
2. All commits as part of a feature branch have been squashed into a single 2. All commits as part of a feature branch have been squashed into a single
commit that has been merged in the `main` branch. commit that has been merged in the `main` branch.
3. Every git pull request has been linked to exactly one project issue. The 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 <pull request title>`.
4. 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.
5. 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.
6. 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.
7. Source code has been linted with `yamllint` and `ansible-lint`. Any issues 7. Source code has been linted with `yamllint` and `ansible-lint`. Any errors
have been resolved. have been fixed.
8. YAML documents have been formated with `yamlfix`. 8. All YAML documents have been formated with `yamlfix`.
9. User facing changes have been documented appropriately. 9. User facing changes have been documented appropriately.
## Development environment setup ## Development environment setup
@ -158,7 +158,7 @@ pipenv install --dev
pipenv shell pipenv shell
``` ```
### Lint Ansible artifacts ## Lint Ansible artifacts
Navigate to the root folder of the local copy of this git repository. Navigate to the root folder of the local copy of this git repository.
@ -178,7 +178,7 @@ Use `ansible-lint` to verify good practices relevant to Ansible.
LC_ALL=C.UTF-8 ansible-lint . LC_ALL=C.UTF-8 ansible-lint .
``` ```
### YAML code formatting ## YAML code formatting
Navigate to the root folder of the local copy of this git repository. Navigate to the root folder of the local copy of this git repository.
@ -192,7 +192,7 @@ Format all YAML documents.
yamlfix . yamlfix .
``` ```
### Execute Ansible Molecule scenarios ## Execute Ansible Molecule scenarios
In order to run all existing Ansible Molecule scenarios, one needs to In order to run all existing Ansible Molecule scenarios, one needs to
follow the steps below. follow the steps below.