Skip to content

Latest commit

 

History

History
100 lines (72 loc) · 4.4 KB

CONTRIBUTING.md

File metadata and controls

100 lines (72 loc) · 4.4 KB
Raw

Contributing to cdk-github

Thank you for contributing to cdk-github! ❤️

This document describes how to set up your development environment and submit your contributions. Please read it and submit a pull request if it's not up-to date 😉.

Prerequisites

Manually install tools

The following tools need to be installed to develop on projen locally.

Getting Started

The basic commands to get the repository cloned and built locally follow:

git clone git@github.com:pepperize/cdk-github
cd cdk-github
 # install dependencies
yarn
# build with projen
yarn build

Development workflow

The projen package provides the following scripts:

  • build - builds the package, generates api docs, runs linter and runs all unit tests
  • watch - watches for file changes and builds them progressively
  • test - executes all unit tests and runs linter
  • test:update - executes all unit tests and overwrites snapshot expectations (those .snap files)
  • test:watch - runs all unit tests and reruns tests when files are changed
  • eslint - runs linter against source code
  • format - runs prettier

Each of these scripts can be executed using yarn <script> or npx projen <script>.

Tests are located under test/.

One trick for quickly iterating is to run yarn watch in one terminal, and yarn test:watch in another. Then, when you change your unit tests the code will automatically recompile, thus triggering the tests to automatically re-run.

Linting & Formatting

Eslint is used to lint and format our typescript code. The eslint script can be run from the root of the package.

You can integrate the linting and formatting workflow with your editor or ide by installing the approporiate eslint plugin. For example, when using Webstorm, the eslint plugin exposes a number of options including "fix on save". This will auto correct lint and formatting errors whenever possible while saving a document.

Projen (CDK for software projects)

This project uses projen to maintain project configuration through code. Thus, the synthesized files with projen should never be manually edited (in fact, projen enforces that).

To modify the project setup, you should interact with rich strongly-typed class AwsCdkConstructLibrary and execute npx projen to update project configuration files.

In simple words, developers can only modify .projenrc.js file for configuration/maintenance and files under /src or /test directory for development.

See also Create and Publish CDK Constructs Using projen and jsii.

Version bumping

Currently, projen bumps versions automatically thru a GitHub action when a commit pushed to master successfully builds. Projen follows semantic versioning through the standard-version npm utility.

Making a pull request

  • Commit title and message (and PR title and description) must adhere to conventionalcommits.
    • The title must begin with feat(module): title, fix(module): title, refactor(module): title or chore(module): title, where the module refers to the projects or components that the change centers on. The module can be omitted, so "feat: title" is okay as well.
    • Title should be lowercase.
    • No period at the end of the title.
  • Commit message should describe motivation. Think about your code reviewers and what information they need in order to understand what you did. If it's a big commit (hopefully not), try to provide some good entry points so it will be easier to follow.
  • Commit message should indicate which issues are fixed: fixes #<issue> or closes #<issue>.
  • Shout out to collaborators.
  • If not obvious (i.e. from unit tests), describe how you verified that your change works.
  • If this commit includes breaking changes, they must be listed at the end in the following format (notice how multiple breaking changes should be formatted):
BREAKING CHANGE: Description of what broke and how to achieve this behavior now
* **module-name:** Another breaking change
* **module-name:** Yet another breaking change