We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
We use Github-Flow, so all
code changes happen through pull requests. Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same GPLv3 License that covers the project. Feel free to contact the maintainers if that's a concern.
By contributing, you agree that your contributions will be licensed under its GPLv3 license. Copy this to the beginning of each file.:
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
We use GitHub issues to track public bugs. Report a bug by opening a new issue. Bug reports that contain confidential information from the UCC context should not be posted on Github. Instead, create an issue in the internal Gitlab. Please also create a dummy-issue here on Github containing the respective link.
These are two good bug report examples:
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)