Mention the CHANGELOG in the README

This commit is contained in:
Jérémy Lecour 2021-02-04 11:13:05 +01:00 committed by Jérémy Lecour
parent 5588ed6009
commit e1458e6a35
1 changed files with 2 additions and 0 deletions

View File

@ -50,6 +50,8 @@ Before starting anything of importance, we suggest contacting us to discuss what
Our conventions are available in the "ansible-public":https://gitea.evolix.org/evolix/ansible-public repository, in the CONVENTIONS.md file.
All modifications should be documented in the CHANGELOG file, to help review releases. We encourage atomic commits, on a single role, and with the CHANGELOG in the same commit.
## Workflow
The ideal and most typical workflow is to create a branch, based on the "unstable" branch. The branch should have a descriptive name (a ticket/issue number is great). The branch can be treated as a pull-request or merge-request. It should be propery tested and reviewed before merging into "unstable".