Contributions are welcome and really appreciated.
If you are unsure how to fix an issue you find, please log an issue in the project repository.
Estrade is dockerized, so the only requirements are Docker and Docker-Compose.
# clone repository
$ git clone email@example.com:cimourdain/estrade.git
$ make init
- Start a new branch :
git checkout -b <branch_name>
- Edit code
- Format your code with
- Review documentation with
docker inspectto find the ip where the doc is exposed locally.)
- Apply pre-commits with
- Check that the tests are passing :
- Check that the style is valid:
- Check that doc can be properly build:
- Check that pre-commit updates were applied:
You can run call checks at once with
If you are unsure about how to fix a failing check, don't worry, we'll be happy to help you during the code review.
Commit message must follow the conventional commit specification.
During developement you are highly incited to use fixups:
$ git commit --fixup=<commit to fixup SHA>