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
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
1
# Contributing Guidelines
2
-
3
2
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4
3
documentation, we greatly value feedback and contributions from our community.
5
4
@@ -26,21 +25,36 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
26
25
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
27
26
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
28
27
29
-
To send us a pull request, please:
30
-
28
+
### Sending a pull request
31
29
1. Fork the repository.
32
30
2. 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.
33
31
3. Ensure local tests pass.
34
-
4. Commit to your fork using clear commit messages.
35
-
5. Send us a pull request, answering any default questions in the pull request interface.
32
+
4. Commit to your fork using a clear commit message following [the Conventional Commits specification](https://www.conventionalcommits.org/).
33
+
5. Send us a pull request, answering any default questions in the pull request template.
36
34
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
37
35
38
36
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
39
37
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
When building locally, some of the packaging steps may fail due to lack of local dependencies. At minimum, you want the `package:js` step to succeed. The later steps (`package:java`, `package:python`, `package:dotnet`) will be run as part of the automated CI in your pull request.
45
+
46
+
### Linking to another project locally
47
+
You may want to perform an `npm link` or something similar to test changes in the library with an actual CDK application residing in another project.
48
+
49
+
1. Build the project such that the `package:js` step succeeds: `yarn build`
3. Perform your `npm link` or similar method using the unpacked `package` directory
52
+
53
+
You may need to manually modify the version in the unpacked `package.json` as appropriate.
54
+
41
55
42
56
## Finding contributions to work on
43
-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
57
+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any "help wanted" issues is a great place to start.
0 commit comments