Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
Table of contents:
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.
We welcome you to contribute features and bug fixes via a pull request. If you are new to contributing to GitHub repositories, then you may find the GitHub documentation on collaborating with the fork and pull model informative; this is the model that we follow.
Please see DEVELOPMENT.md for information about how to navigate this package's code base and development practices.
If you are not sure what you would like to contribute, then looking at the existing issues is a great way to find something to contribute on. Looking at issues that have the "help wanted" or "good first issue" labels are a good place to start, but please dive into any issue that interests you whether it has those labels or not.
We ask that you please open a feature request issue (if one does not already exist) and talk with us before posting a pull request that contains a significant amount of work, or one that proposes a change to a public interface such as to the interface of a publicly exported Python function or to the command-line interfaces' commands or arguments. We want to make sure that your time and effort is respected by working with you to design the change before you spend much of your time on it. If you want to create a draft pull request to show what you are thinking and then talk with us, then that works with us as well.
We prefer that this package contain primarily features that are useful to many users of it, rather than features that are specific to niche workflows. If you have a feature in mind, but are not sure whether it is niche or not then please open a feature request issue. We will do our best to help you make that assessment, and posting a public issue will help others find your feature idea and add their support if they would also find it useful.
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
- You are working against the latest source on the mainline branch.
- You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
- You open an issue to discuss any significant work - we would hate for your time to be wasted.
- Your pull request will be focused on a single change - it is easier for us to understand when a change is focused rather than changing multiple things at once.
To send us a pull request, please:
- Fork the repository.
- Modify the source and add tests for your change; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. Please see DEVELOPMENT.md for tips.
- Ensure tests pass. Please see the Testing section for information on tests.
- IMPORTANT: Commit to your fork using clear commit messages. Note that all AWS Deadline Cloud GitHub repositories require the use of conventional commit syntax for the title of your commit.
- IMPORTANT: Ensure that your commit is signed for Developer Certificate of Origin (
git commit --amend -s). Be aware that your configureduser.emailvalue will be embedded in the commit message for all to see. We recommend that you configure GitHub to block pushes that expose your email, setup GitHub to keep your email private, and use GitHub's provided noreply email address as theuser.emailsetting in git. - Send us a pull request, answering any default questions in the pull request interface.
- Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
GitHub provides additional documentation on forking a repository and creating a pull request.
The commits in this repository are all required to use conventional commit syntax in their title to help us identify the kind of change that is being made, automatically generate the changelog, and automatically identify next release version number. Only the first commit that deviates from mainline in your pull request must adhere to this requirement.
The title of your commit will appear in the release notes for the package, so we ask that you write the commit title so that a customer reading the release notes can understand what was fixed or added. For example, a bug fix title should not be about how the fix was made, but instead be about the bug that was fixed.
We ask that you use these commit types in your commit titles:
feat- When the pull request adds a new feature or functionality;fix- When the pull request is implementing a fix to a bug;test- When the pull request is only implementing an addition or change to tests or the testing infrastructure;docs- When the pull request is primarily implementing an addition or change to the package's documentation;refactor- When the pull request is implementing only a refactor of existing code;ci- When the pull request is implementing a change to the CI infrastructure of the packge;chore- When the pull request is a generic maintenance task.
We also require that the type in your conventional commit title end in an exclaimation point (e.g. feat! or fix!)
if the pull request should be considered to be a breaking change in some way. Please also include a "BREAKING CHANGE" footer
in the description of your commit in this case (example).
Examples of breaking changes include any that implements a backwards-imcompatible change to a public Python interface,
the command-line interface, or the like.
If you need change a commit message, then please see the GitHub documentation on the topic to guide you.
See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.