Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

24 lines (13 loc) · 1.32 KB

Contributing to Angular Redux

Package Management

This repo utilizes Yarn Workspaces for package management. Please install and use Yarn as your npm client for this project. The npm cli is not supported for package installation.

Commit Message Guidelines

We follow the Conventional Commits guidelines. These are enforced through the use of commitlint. If you would like a more interactive way of formatting your commit messages, run yarn commit once your changes are staged.

Releases

Canary Releases

This repo is setup to automatically release canary builds for every commit that is pushed to master. In order to access those builds, run npm install @angular-redux/store@canary (or whichever package you are looking to use)

Stable Releases

For stable releases, the build and publishing is done automatically for CircleCI. If you have write access to the repo, run the following steps to automatically release a new version to latest

  • Pull down the latest version of master to your local machine
  • Run yarn release:stable

The release commit will be automatically pushed to master where CircleCI will complete the remaining publishing steps.