You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.adoc
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The following labels are used to track bug related issues: link:https://github.c
16
16
=== Before Submitting a Bug Report
17
17
Before submitting a bug report, please do the following:
18
18
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.
20
20
21
21
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).
22
22
@@ -35,7 +35,7 @@ So that we are able to assist you as effectively as possible with the issue, ple
35
35
=== Tracking your Bug Report
36
36
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.
37
37
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.
39
39
40
40
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.
41
41
@@ -62,10 +62,10 @@ Contributions to the workshop are done through link:https://github.com/aws-sampl
62
62
63
63
* 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)].
64
64
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.
66
66
67
67
[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.
69
69
70
70
[NOTE]
71
71
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
76
76
* [ ] Includes tests to exercise the new behavior
77
77
* [ ] Code is documented, especially public and user-facing constructs
78
78
* [ ] 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
80
80
81
81
[NOTE]
82
82
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
87
87
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.
88
88
89
89
== Getting in Contact
90
-
* Come chat with us on link:https://gitter.im/aws-samples/aws-workshop-for-kubernetes[Gitter]!
0 commit comments