Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (16 loc) · 887 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 887 Bytes

How to contribute

Before opening a pull request

  • Be sure all tests pass: npm t.
  • Ensure good test coverage and write new tests if necessary: npm run coverage.
  • Add your changes to CHANGELOG.md.

Release process

If you are a maintainer, please follow the following release procedure:

  • Merge all desired pull requests into main.
  • Run npm run build to generate a new dist bundle.
  • Bump package.json to a new version and run npm i to generate a new package-lock.json.
  • Add new version to CHANGELOG.
  • Paste contents of CHANGELOG into new version commit.
  • Open and merge a pull request with those changes.
  • Tag the merge commit as the a new release version number.
  • Publish commit to npm.
  • Submit a pull request to the Roosevelt website following the instructions here.