|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +Thank you for your interest in contributing to our project. |
| 4 | +Whether it's a bug report, new feature, correction, or additional |
| 5 | +documentation, we greatly value feedback and contributions from our community. |
| 6 | + |
| 7 | +Please read through this document before submitting any |
| 8 | +issues or pull requests to ensure we have all the necessary |
| 9 | +information to effectively respond to your bug report or contribution. |
| 10 | + |
| 11 | +## Reporting Bugs/Feature Requests |
| 12 | + |
| 13 | +We welcome you to use the GitHub issue tracker to report bugs or suggest features. |
| 14 | + |
| 15 | +When filing an issue, please check existing open, or recently closed, |
| 16 | +issues to make sure somebody else hasn't already |
| 17 | +reported the issue. |
| 18 | +Please try to include as much information as you can. |
| 19 | +Details like these are incredibly useful: |
| 20 | + |
| 21 | +* A reproducible test case or series of steps |
| 22 | +* The version of our code being used |
| 23 | +* Any modifications you've made relevant to the bug |
| 24 | +* Anything unusual about your environment or deployment |
| 25 | + |
| 26 | +## Contributing via Pull Requests |
| 27 | + |
| 28 | +Contributions via pull requests are much appreciated. |
| 29 | +This repository use [pre-commit](https://pre-commit.com/) hooks for linting. |
| 30 | +Before sending us a pull request, please ensure that: |
| 31 | + |
| 32 | +1. You are working against the latest source on the *main* branch. |
| 33 | +1. You check existing open, and recently merged, |
| 34 | + pull requests to make sure someone else hasn't addressed the problem already. |
| 35 | +1. You open an issue to discuss any significant work - we would hate |
| 36 | + for your time to be wasted. |
| 37 | + |
| 38 | +To send us a pull request, please: |
| 39 | + |
| 40 | +1. Fork the repository. |
| 41 | +1. Modify the source; please focus on the specific change you are contributing. |
| 42 | + If you also reformat all the code, it will be hard for us to focus on your change. |
| 43 | +1. Ensure local tests pass. |
| 44 | +1. Commit to your fork using clear commit messages. |
| 45 | +1. Send us a pull request, answering any default questions in the pull request interface. |
| 46 | +1. Pay attention to any automated CI failures reported in the pull request, |
| 47 | + and stay involved in the conversation. |
| 48 | + |
| 49 | +> Note: you may need to update the commit if `pre-commit` changes/suggests changes to files |
| 50 | +
|
| 51 | +GitHub provides additional document on |
| 52 | +[forking a repository](https://help.github.com/articles/fork-a-repo/) and |
| 53 | +[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). |
| 54 | + |
| 55 | +## Finding contributions to work on |
| 56 | + |
| 57 | +Looking at the existing issues is a great way to find something to contribute on. |
| 58 | +As our projects, by default, use the default GitHub issue labels |
| 59 | +(enhancement/bug/duplicate/help wanted/invalid/question/wontfix), |
| 60 | +looking at any 'help wanted' issues is a great place to start. |
| 61 | + |
| 62 | +## Code of Conduct |
| 63 | + |
| 64 | +This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). |
| 65 | +For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) |
| 66 | +or contact |
| 67 | +[email protected] with any additional questions or comments. |
| 68 | + |
| 69 | +## Security issue notifications |
| 70 | + |
| 71 | +If you discover a potential security issue in this project we ask |
| 72 | +that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). |
| 73 | +Please do **not** create a public github issue. |
| 74 | + |
| 75 | +## Licensing |
| 76 | + |
| 77 | +See the [LICENSE](LICENSE) file for our project's licensing. |
| 78 | +We will ask you to confirm the licensing of your contribution. |
0 commit comments