First off, thanks for taking the time to contribute!
These guidelines are a living document and open to change via a pull request.
It's a Python project, there is no reason not to follow PEP8. There are a few exceptions:
- line length < 100 (not 80) if at all possible
- one-line docstrings are acceptable, but feel free to step up to full docstrings with parameters named and return values specified.
The project uses GitHub's built-in issue tracker. Check there if there is something that matches your skills and interests.
- Optional: create a virtual environment:
virtualenv cw2g && . cw2g/bin/activate - Install requirements:
pip install -r requirements.txt - Run the test suite:
make test - Verify the tests pass over all supported Python versions:
tox
Standard-issue github project flow, summarized:
- Fork the repo
- Create a branch
- Check in your changes
- Create a pull request
5. An existing contributor will do a code review, and as applicable ask for changes, mark the pull request with a 👍, or merge it in, bump the version number, and cut/tag a release.
This section guides you through submitting a bug report for cloudwatch-to-graphite. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please check the issue tracker, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.