2.4 KiB
Contributing to Homepage
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 project
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We Develop with Github
We use github to host code, to track issues and feature requests, as well as accept pull requests.
Any contributions you make will be under the GNU General Public License v3.0
In short, when you submit code changes, your submissions are understood to be under the same GNU General Public License v3.0 that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github discussions
We use GitHub discussions to triage bugs. Report a bug by opening a new discussion; it's that easy!
Write bug reports with detail, background, and sample configurations
Homepage includes a lot of configuration options and is often deploying in larger systems. Please include as much information (configurations, deployment method, Docker & API versions, etc) as you can when reporting an issue.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give example configurations 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)
People love thorough bug reports. I'm not even kidding.
Development Guidelines
Please see the documentation regarding development and specifically the guidelines for new service widgets if you are considering making one.
Use a Consistent Coding Style
Please see information in the docs regarding code formatting with pre-commit hooks.
License
By contributing, you agree that your contributions will be licensed under its GNU General Public License.
References
This document was adapted from the open-source contribution guidelines for Facebook's Draft