If you do not have have write access to the repository, the preferred way of submitting your contributions to the project is through a pull request.
Before pushing your changes submitting your pull request, kindly consider:
- Being consistent with the style of the existing code and documentation
- Making sure that you understand the directory arrangement of the project
- Ensuring the quality of your contribution
- Providing us with some context about your pull request description and why you think that your enhancements are required.
We appreciate your interest in contributing to this project.
To accept your code contributions, we assume that:
-
You can write concise, maintainable and robust code.
-
You have set up your Development Environment and Tools using similar configurations to ours. Especially the tools that check your programming style and perform static code analysis and verification. To setup your development environment appropriately we suggest you refer to our Development Environment setup guide. This will save everyone a lot of time.
-
You know how to use Test-Driven-Development that your code is accompanied by appropriate test cases and documentation.
-
You understand that all your contributions have to be reviewed by other programmers prior to being integrated in the project.
To accept your documentation contributions, we assume that:
- You know how to write clean documents using Markdown syntax
- You are capable of writing in an organised and and concise way
- You have spell-checked your text
- You have proof-read what and re-written your text at least twice