Contributing¶
How to contribute to this project.
Fork this repository¶
Fork this repository before contributing.
Next, clone your fork to your local machine, keep it up to date with the upstream, and update the online fork with those updates.
git clone https://github.com/YOUR-USERNAME/grafanarmadillo.git
cd grafanarmadillo
git pull origin main
Install for developers¶
Run lints and formatters with pants fix lint ::.
Run tests with pants test :: . Many of the tests will rely on a test Docker container to integrate with a Grafana instance. By default this only runs on Linux, but can be forced by setting “do_containertest” to “True”
Update CHANGELOG¶
Update the changelog file under docs/CHANGELOG.rst with an explanatory bullet list of your contribution. Add that list right after the main title and before the last version subtitle:
Changelog
=========
* here goes my new additions
* explain them shortly and well
vX.X.X (1900-01-01)
-------------------
Also add your name to the authors list at docs/AUTHORS.rst.
Pull Request¶
Once you are finished, you can Pull Request you additions to the main repository, and engage with the community. Please read the PULLREQUEST.rst guidelines first, you will see them when you open a PR.
Before submitting a Pull Request, verify your development branch passes all tests **. If you are developing new code you should also implement new test cases.