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.md
+12-5
Original file line number
Diff line number
Diff line change
@@ -14,27 +14,34 @@ When filing an issue, please check [existing open](https://github.com/aws-soluti
14
14
15
15
- A reproducible test case or series of steps
16
16
- The version of our code being used
17
+
- The region being used
17
18
- Any modifications you've made relevant to the bug
18
19
- Anything unusual about your environment or deployment
19
20
20
21
## Contributing via Pull Requests
21
22
22
23
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
23
24
24
-
1. You are working against the latest source on the _main_ branch.
25
+
1. You are working against the latest source on the _develop_ branch.
25
26
1. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
26
27
1. You open an issue to discuss any significant work - we would hate for your time to be wasted.
28
+
1. Note that the head of the develop branch contains latest features being developed for the solution.
29
+
1. Changes in this branch will be unstable and are not recommended for production deployments.
27
30
28
31
To send us a pull request, please:
29
32
30
33
1. Fork the repository.
31
-
1. 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.
32
-
1. Ensure local tests pass.
34
+
1. Modify the source; please focus on the specific change you are contributing.
35
+
1. Add new unit tests for the new code.
36
+
1. Run _npx npm run prettier-format_ in _source_ to ensure that code format standards are maintained.
37
+
1. If your changes include new capabilities, include in the PR description text that can be folded into the solution documentation.
33
38
1. Commit to your fork using clear commit messages.
39
+
1. Ensure that github Actions pass for all Required tasks.
40
+
1. In your repository _Security_ section, ensure that security advisories are enabled and address any Dependabot issues that appear.
34
41
1. Send us a pull request, answering any default questions in the pull request interface.
35
-
1.Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
42
+
1.If the changes are complex or may involve additional communication, we may create a feature branch specific to your PR and ask you to rebase using that branch.
36
43
37
-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
44
+
GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
0 commit comments