Contribute

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!

Creating Issues

Contributions are tracked via GitHub issues. Before contributing code or documentation:

  1. Check whether any open issues already cover your contribution.
  2. If not, create a new issue with a detailed description of the problem to be solved.

Making Changes

To resolve an issue, you’ll probably need to make a change to the Braubuddy codebase:

  1. Fork the Braubuddy repository.

  2. Create a new branch off develop in which to work on the issue in question.

  3. 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).

Submitting Changes

  1. Push changes to your branch.
  2. Submit a Pull Request. If you’re new to creating PRs, this article on Effective Pull Requests is a good place to start.
  3. Wait for feedback.

Braubuddy

A temperature management framework written in Python.

Navigation