Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.51 KB

Contributing to Sensitive Param Filter

Please follow the appropriate template when opening an issue or pull request:

Understand that it may take several days for your contribution to be reviewed (in particular if you open it on a weekend).

Contributing Code

  1. Fork our repo using the Fork button here.
  2. Clone your fork: git clone git@github.com:your_username/sensitive-param-filter.git
  3. Run npm install to install development dependencies
  4. Make your changes and push them to your fork
  5. Open a pull request here

Scripts

  • npm install installs development dependencies
  • npm run test runs the test suite using jest
  • npm run lint ensures your code matches our standards via eslint

Publishing

sensitive-param-filter is published to both GitHub Packages and npm. Ensure you are authenticated with both:

Use npm run release (ensure master is checked out) to publish new versions.