Contributions are encouraged and greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
If you are reporting a bug or issues, please include:
- Operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting (E.G. Python version if using a python script, Terraform version if you're using a Terraform script.).
- Detailed steps to reproduce the bug.
Check the Issues for this repo on GitHub. Anything tagged with a "bug" ticket type is open to whoever wants to implement it.
If you have a great set of dashboards, detectors, API scripts for sending metrics, or any other content you believe will be of use to others, please contribute it!
Or check the Issues for this repo on GitHub. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Submissions and README.md files could always use more documentation. Documentation can always use an update or tweak in the official docs, in docstrings of scripts, comments in configs, or anywhere a bit of clarity may be useful..
If you are proposing a feature:
- 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 contributions are welcome :)
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include a
README.mdfor any new submission. - If the pull request adds functionality, the
README.mddocs for that component or submission should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md. - Terraform submissions should work with the most current version of the included Terraform Provider.
- Python submissions should work for Python3