Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (15 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 1.03 KB
Raw

How to contribute

Before opening a pull request

  • Be sure all tests pass: npm t. That runs the node tests and then drives the express sample app in a real browser, which needs the sample app's own dependencies (cd sampleApps/express && npm ci) and a browser (npx playwright install chromium).
  • 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.
  • 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.