| While True Do Contribution Guidelines
This guideline is only a snapshot. Please have a look here to check the latest version.
Thank you so much for considering to contribute. Every contribution helps us. We are really happy, when somebody is joining the hard work.
In this document you can find some guidance, how you can take care of bugs, submit changes and buildup of your environment.
- Documents: https://github.com/while-true-do/community/
- Issue tracker: linked in every README.md
- Website: https://while-true-do.org
- Github: https://github.com/while-true-do/
- Communication: [email protected]
Reporting Bugs should follow some simple rules:
- Check, if you can find similar Bugs.
- Describe, what is happening and what should happen.
- Explain, why this is a problem.
- Add more details and attachments.
- Follow up, if somebody is having questions or needs more details.
Templates: ISSUE_TEMPLATE.md
Submitting a change is quite easy and adheres to the below rules:
- Needs an issue to understand and discuss where the Change belongs to.
- Commit Messages must follow our guidelines in COMMIT_TEMPLATE.md
- Pull Requests must follow the guidelines in PULL_REQUEST_TEMPLATE.md
- Don't mix up different changes in one request.
- Use @mentions will help to notify everybody who might be able to have a look at the request.
Templates: PULL_REQUEST_TEMPLATE.md, COMMIT_TEMPLATE.md
Please take care of the documentation. In most cases, at least the README.md should be reviewed and properly updated, to reflect the made changes. In addition having proper comments in the code is helping a lot to avoid a heavy documentation aside.
- Use a linting tool should help to avoid common typing errors or misbehaviour of your code.
- Use and update the tests, that are provided in the repositories. In most cases at least some syntax checking and linting should be in place. For larger projects the testing can be little bit heavier.