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