Skip to content

Commit c1c4a3d

Browse files
committed
update to use official docs
2 parents 5b5ac81 + d1402d9 commit c1c4a3d

File tree

3 files changed

+54
-55
lines changed

3 files changed

+54
-55
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,61 @@
11
# Contributing Guidelines
22

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.
68

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.
109

1110
## Reporting Bugs/Feature Requests
1211

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.
1513

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:
2216

2317
* A reproducible test case or series of steps
2418
* The version of our code being used
2519
* Any modifications you've made relevant to the bug
2620
* Anything unusual about your environment or deployment
2721

22+
2823
## 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:
3125

3226
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.
3729

3830
To send us a pull request, please:
3931

4032
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.
4434
3. Ensure local tests pass.
4535
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.
5038

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/).
5341

5442

5543
## 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+
6146

6247
## Code of Conduct
6348
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.
6451

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.
6852

6953
## 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+
7356

7457
## Licensing
7558

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.
7960

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.

NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,46 @@
1-
# Closed Issues Message
1+
## Closed Issue Message
22

33
This action sets a default message to be commented on all issues when they get closed.
44

5-
## Inputs
5+
## Usage
66

7-
### `closed-issues-message`
7+
Add a YAML workflow file into your repository under
8+
`.github/workflows`.
9+
This workflow file follows the
10+
[standard workflow syntax for Github Actions](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions).
811

9-
**Required** The message you want to be commented whenever an issue is closed.
10-
11-
## Example workflow
12+
For a list of options and their description, see [action.yml](./action.yml).
1213

14+
### Example Workflow
1315
```yml
14-
name: Closed Issues Message
16+
name: Closed Issue Message
1517
on:
1618
issues:
1719
types: [closed]
1820
jobs:
1921
auto_comment:
2022
runs-on: ubuntu-latest
2123
steps:
22-
- uses: SomayaB/closed-issues-message
24+
- uses: aws-actions/closed-issue-message
2325
with:
2426
# These inputs are both required
2527
repo-token: "${{ secrets.GITHUB_TOKEN }}"
26-
closed-issues-message: "Warning: comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so."
28+
message: "Comments on closed issues are hard for our team to see."
29+
```
30+
> You can do a multi line comment by using a pipe:
31+
```yml
32+
message: |
33+
### ⚠️COMMENT VISIBILITY WARNING⚠️
34+
Comments on closed issues are hard for our team to see.
35+
If you need more assistance, please either tag a team member or open a new issue that references this one.
36+
If you wish to keep having a conversation with other community members under this issue feel free to do so.
37+
2738
```
39+
![closed issue message example](comment-example.png)
40+
## Security
41+
42+
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
43+
44+
## License
45+
46+
This project is licensed under the Apache-2.0 License.

0 commit comments

Comments
 (0)