CONTRIBUTING.md

Contributing to Contrast-Finder

👍 First off, thanks for taking the time to contribute! 👍

We are really glad to have you on board ! You can help in many ways:

1. Use Contrast-Finder !
2. Help translate Contrast-Finder
3. Give us feedback on the forum or fill in bug report

Pull Requests are always welcome!

Fill in bug reports

Fill in a bug report

• Please do not assign issue to anyone.
• You may assign an issue to yourself, meaning to others "I'm actually working on this issue".
• When closing an issue, please always add a comment explaining why you are closing it.

Contribution to the code / Pull Request

Please always work on develop branch.

Master is meant to be directly usable in production, thus only contains tagged releases.

Styleguides

• Git Commit message

Builds and runs a Docker container

• builds Contrast-Finder from sources,
• builds a Docker image
• runs a container based the freshly built image

git clone https://github.com/Asqatasun/Contrast-Finder
cd Contrast-finder
git checkout develop
docker/build_and_run-with-docker.sh -l -s ${PWD} -d docker/SNAPSHOT-local

Sources of inspiration for CONTRIBUTING.md

• For contributors doc Gitlab Workflow
• Atom's Contributing file that is really good and brightly written.