How we develop

The issue related to this page is #21

This is a small guide on how we develop. Our goal is to have documented, good looking and well-tested code.

When creating a commit

• Write in present tense

When adding a feature

1. Create a branch with a creative name using for example the command git checkout -b add-feature-x.
2. Create test(s) for your feature.
3. Implement your feature.
4. Make sure that all tests passes.
5. Create pull request.
6. In the comment of the pull request write "Resolves/Fixes X" where X is the an issue's identification (for example #23). Note that this is only applicable if the pull request is related to an issue.

When merging a pull request to master

• One uninvolved reviewer needs to approve the pull request.
• Reviewer is responsible for quality and formatting the pull request.
• Make sure that the prefix of the commit (that will be shown on master) is either "feat", "fix", "doc" or "refactor". For example an acceptable commit message is "feat: Add Lic X implementation."
• Reviewer is responsible for squashing the pull request (use the squash and merge option).
• Reviewer is responsible for deleting the branch.

Good luck!