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