There are many ways in which you can help to make Braubuddy better:
- Report bugs.
- Request or add support for new
components. - Request or add new features.
- Improve documentation.
- Spread the word through blogging, social media etc.
All contributions are most welcome!
Contributions are tracked via GitHub issues. Before contributing code or documentation:
- Check whether any open issues already cover your contribution.
- If not, create a new issue with a detailed description of the problem to be solved.
To resolve an issue, you'll probably need to make a change to the Braubuddy codebase:
- Fork the Braubuddy repository.
- Create a new branch off
developin which to work on the issue in question. - Make your changes, ensuring that:
- Commits are made in logical units.
- Commit messages are well formatted.
- Commit messages reference related issues.
- Python code is PEP8 compliant, (flake8 is a useful tool for linting your code).
- Python code is unit tested, (coverage is a useful tool for determining your test coverage).
- All unit tests pass, (nose is a useful tool for running unit tests).
- Push changes to your branch.
- Submit a Pull Request. If you're new to creating PRs, this article on Effective Pull Requests is a good place to start.
- Wait for feedback.