Skip to content

Commit 1bdb070

Browse files
author
Eugene Cheung
authored
chore(docs): add instructions on how to build and link locally [skip ci] (#334)
--- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_
1 parent 0f97cda commit 1bdb070

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Contributing Guidelines
2-
32
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
43
documentation, we greatly value feedback and contributions from our community.
54

@@ -26,21 +25,36 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
2625
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2726
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
2827

29-
To send us a pull request, please:
30-
28+
### Sending a pull request
3129
1. Fork the repository.
3230
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.
3331
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.
3634
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3735

3836
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
3937
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4038

39+
### Building the project locally
40+
1. Install Yarn: https://classic.yarnpkg.com/lang/en/docs/install
41+
2. Install the dependencies: `yarn install`
42+
3. Build the project: `yarn build`
43+
44+
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`
50+
2. Unpack the JS package: `tar zxvf dist/js/[email protected]`
51+
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+
4155

4256
## 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.
4458

4559

4660
## Code of Conduct

0 commit comments

Comments
 (0)