Thank you for considering a contribution. Here are some guidelines to help you do so.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Our code is in Python, check out the Google Python Style Guide for code tips and best practices.
When creating a new issue, look to make sure that a similar issue has not already been opened. Add a label for triaging purposes. Here are some labels to use:
| Label name | Description |
|---|---|
bug |
Bug report with the master branch. Include detailed configuration information and error logs. |
documentation |
An issue with the documentation such as incorrect or insufficient information. |
feature |
A new feature request for the tool. |
enhancement |
An enhancement request for an existing feature. |
good first issue |
A relatively easy issue new contributors can work on. |
duplicate |
The issue is a duplicate of another issue or pull request. |
question |
Issues that are just questions addressed to the developers/ community. |
- Start commit message with uppercase letter
- Use present tense ("Add feature" not "Added feature")
- Reference relevant issues and pull requests
-
Ensure any install or build dependencies are removed before the end of the layer when doing a build.
-
Update the relevant README.md with sufficient details whenever significant code changes are made to the tool.
-
When opening a pull request, please open it in draft mode if it still a work in progress, and do not mark it for review.
-
Fill out the pull request description with details on what changes were made and how it can be tested. Request review once this is done.
-
Once the pull request is reviewed and approved by a maintainer, the code will be merged by them.