Skip to content

Commit 75dd220

Browse files
committed
Update to Contributing Guidelines per comment
1 parent f6f29f0 commit 75dd220

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

CONTRIBUTING.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The following labels are used to track bug related issues: link:https://github.c
1616
=== Before Submitting a Bug Report
1717
Before submitting a bug report, please do the following:
1818

19-
1. Do a search through the existing issues to make sure it has not already been reported. If there's an existing one, be sure give a +1 reaction which will help us prioritize which issues to address first.
19+
1. Do a search through the existing issues to make sure it has not already been reported. If there's an existing one, be sure to give a +1 reaction which will help us prioritize which issues to address first.
2020

2121
2. Provide as much information about your environment, software version, and relevant dependencies as possible. For example, let us know what version of kubernetes you are using, which launch type for the kubernetes cluster (e.g. EKS or kops), and the environment your code is running in. (e.g Cloud9).
2222

@@ -35,7 +35,7 @@ So that we are able to assist you as effectively as possible with the issue, ple
3535
=== Tracking your Bug Report
3636
You will automatically be notified of any changes to a bug report. Either a maintainer or a community member may comment on the bug report requiring further input. We encourage all contributors to stay active on their bug reports reports. This helps the community to focus on issues with more influence and activity.
3737

38-
We understand that contributors cannot devote 100% of their time to a project, just as our maintainers cannot devote 100% of their time to the project.. We want to squash bugs as often as we can, but sometimes require comments from the submitter or community in order to proceed.
38+
Any input to the workshop is always appreciated. Our maintainers cannot devote 100% of their time to this project, but will try to respond in a timely manner. We want to squash bugs as often as we can, but sometimes require comments from the submitter or community in order to proceed.
3939

4040
If a bug report has been inactive (waiting on comment from submitter or community) for 14 days, a maintainer may label the issue as stale. Once a bug report has been inactive for more than 28 days, the issue will be administratively closed. Issues can be re-opened after being administratively closed by commenting on the issue requesting to re-open and providing the necessary comment.
4141

@@ -62,10 +62,10 @@ Contributions to the workshop are done through link:https://github.com/aws-sampl
6262

6363
* The workshop is released under the link:https://github.com/aws-samples/aws-workshop-for-kubernetes/blob/master/LICENSE[Apache 2.0 License]. Any code you submit will be released under this license. If you are contributing a large/substantial enhancement, you may be asked to sign a link:https://github.com/aws/aws-cla[Contributor License Agreement (CLA)].
6464

65-
* For anything but very small or quick changes, you should always start by checking the link:https://github.com/aws-samples/aws-workshop-for-kubernetes/issues[Issues] page to see if the work is already being done by another person.
65+
* You should always start by checking the link:https://github.com/aws-samples/aws-workshop-for-kubernetes/issues[Issues] page to see if the work is already being done by another person. We require that pull requests reference an issue.
6666

6767
[NOTE]
68-
If you're working on a bug fix, check to see if the bug has already been reported. If it has but no one is assigned to it, ask one of the maintainers to assign it to you before beginning work. If you're confident the bug hasn't been reported yet, create a new link:#bug-reports[Bug Report] then ask to be assigned to it.
68+
If you're working on a bug fix, check to see if the bug has already been reported. If it has but no one is assigned to it, comment that you are assigning it to yourself before beginning work. If you're confident the bug hasn't been reported yet, create a new link:#bug-reports[Bug Report] then comment that you are assigning it to yourself.
6969

7070
[NOTE]
7171
If you are thinking about adding entirely new functionality, open an link:#enhancements[Enhancements] or link:https://gitter.im/aws-samples/aws-workshop-for-kubernetes[ping] the maintainers to ask for feedback first before beginning work; again this is to make sure that no one else is already working on it, and also that it makes sense to be included in the workshop.
@@ -76,7 +76,7 @@ Before submitting your pull request, refer to the pull request readiness checkli
7676
* [ ] Includes tests to exercise the new behavior
7777
* [ ] Code is documented, especially public and user-facing constructs
7878
* [ ] Git commit message is detailed and includes context behind the change
79-
* [ ] If the change is related to an existing Bug Report or Enhancement, the issue number is referenced
79+
* [ ] The issue number for the bug report or enhancement is referenced
8080

8181
[NOTE]
8282
Some changes have additional requirements. Refer to the section below to see if your change will require additional work to be accepted.
@@ -87,4 +87,7 @@ All Pull Requests must be reviewed and approved by at least two other contributo
8787
If your branch has more than one commit when it's approved, you may also be asked to link:https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History[squash] them into a single commit before it is merged in.
8888

8989
== Getting in Contact
90-
* Come chat with us on link:https://gitter.im/aws-samples/aws-workshop-for-kubernetes[Gitter]!
90+
Come chat with us on:
91+
* link:https://gitter.im/aws-samples/aws-workshop-for-kubernetes[Gitter]!
92+
* **#eks** channel in **Kubernetes** Slack workspace
93+
* **#containers** and **#kubernetes** channels in **aws-developers** Slack workspace

0 commit comments

Comments
 (0)