Skip to content

Commit 75c6b24

Browse files
dougtoppinDoug Toppin
and
Doug Toppin
authored
chore(docs): Update contributing for develop branch and PR steps (aws-solutions#421)
* Update node version * Update contributing for develop branch and PR steps * Update CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, Add package-lock to gitignore Co-authored-by: Doug Toppin <[email protected]>
1 parent c72ba3b commit 75c6b24

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99

1010
**Checklist**
11+
- [ ] :wave: I have added unit tests for all code changes.
1112
- [ ] :wave: I have run the unit tests, and all unit tests have passed.
1213
- [ ] :warning: This pull request might incur a breaking change.
1314

CONTRIBUTING.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,34 @@ When filing an issue, please check [existing open](https://github.com/aws-soluti
1414

1515
- A reproducible test case or series of steps
1616
- The version of our code being used
17+
- The region being used
1718
- Any modifications you've made relevant to the bug
1819
- Anything unusual about your environment or deployment
1920

2021
## Contributing via Pull Requests
2122

2223
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
2324

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.
2526
1. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2627
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.
2730

2831
To send us a pull request, please:
2932

3033
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.
3338
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.
3441
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.
3643

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

3946
## Finding contributions to work on
4047

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In addition to the AWS Solutions Constructs, the solution uses AWS CDK directly
4646
## Prerequisites for Customization
4747

4848
- [AWS Command Line Interface](https://aws.amazon.com/cli/)
49-
- Node.js 14.x or later
49+
- Node.js 16.x or later
5050

5151
### 1. Clone the repository
5252

0 commit comments

Comments
 (0)