Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 3.85 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 3.85 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Contributing via Pull Requests

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

  1. You are working against the latest source on the main branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

Sending a pull request

  1. Fork the repository.
  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.
  3. Ensure local tests pass.
  4. Commit to your fork using a clear commit message following the Conventional Commits specification.
  5. Send us a pull request, answering any default questions in the pull request template.
  6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Building the project locally

  1. Install Yarn: https://classic.yarnpkg.com/lang/en/docs/install
  2. Install the dependencies: yarn install
  3. Build the project: yarn build

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.

Linking to another project locally

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.

  1. Build the project such that the package:js step succeeds: yarn build
  2. Unpack the JS package: tar zxvf dist/js/[email protected]
  3. Perform your npm link or similar method using the unpacked package directory

You may need to manually modify the version in the unpacked package.json as appropriate.

Finding contributions to work on

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.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.