How to Help

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Write Documentation

ccu could always use more documentation in the form of how-to guides, tutorials, and conceptual explanation. Check out Contributing Documentation for instructions on how to start.

Provide Feedback

The best way to send feedback is to file an issue. This is includes if you need help. If something is too difficult to figure out, that’s an issue!

Report a Bug

Report bugs on the GitLab issue tracker. When reporting a bug, please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting. (e.g., Python version, ccu version)

  • Detailed steps to reproduce the bug.

Fix a Bug

Look through the GitLab issues for bugs. To indicate that you are going to work on a particular bug, comment on the issue.

Propose a Feature

Propose features on the GitLab issues page. When proposing a feature, please include:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Implement a Feature

Look through the GitLab issues for features to implement. To indicate that you are going to work on a particular feature, comment on the issue.