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
+9-8
Original file line number
Diff line number
Diff line change
@@ -28,23 +28,24 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
28
28
1. You are working against the latest source on the **main** branch.
29
29
2. You check existing open, and recently merged pull requests to make sure someone else hasn't addressed the problem already.
30
30
3. You open an [RFC issue](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=RFC%2C+triage&template=rfc.md&title=RFC%3A+) to discuss any significant work - we would hate for your time to be wasted.
31
+
4. You lint and test the code. When you've setup the repository with `npm run init-environment`, pre-commit and push-hooks will automatically lint and test the code. Pull request builds will run the same checks as well.
31
32
32
33
### Dev setup
33
34
34
35
To send us a pull request, please follow these steps:
35
36
36
37
1. Fork the repository.
37
38
2. Install dependencies: `npm install`
38
-
3. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling`
39
-
4. Run all tests, and code baseline checks: `npm run test`
40
-
5. Commit to your fork using clear commit messages.
41
-
6. Send us a pull request with a [conventional semantic title](https://github.com/awslabs/aws-lambda-powertools-typescript/pull/67), and answering any default questions in the pull request interface.
42
-
7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
43
-
44
-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
39
+
3. Prepare utilities like commit hooks: `npm run init-environment`
40
+
4. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling`
41
+
5. Run all tests, and code baseline checks: `npm run test`
42
+
6. Commit to your fork using clear commit messages.
43
+
7. Send us a pull request with a [conventional semantic title](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/semantic.yml), and answering any default questions in the pull request interface. [Here's an example](https://github.com/awslabs/aws-lambda-powertools-python/pull/67).
44
+
8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
45
+
46
+
GitHub provides an additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
45
47
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
0 commit comments