Skip to content
This repository has been archived by the owner on Oct 8, 2019. It is now read-only.

Latest commit

 

History

History
33 lines (21 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.22 KB
Raw

Contribute.md

Contributions are welcome. Please open a pull request.

Tests

patrol-rules-aws has both linting and unit tests. You can start the whole test suite via npm test which will first execute the eslint tests, then the unit tests. The whole test suite is also run by Travis CI.

Linting

eslint is used for linting the JavaScript. Run it separately from the unit tests via npm run lint.

Unit tests

Unit tests are done with tape. Start them with npm run unit-test. The unit tests live in /test.

Releasing a new version

  1. Do excellent things in a PR
  2. Merge PR to master
  3. Make a release commit with:
  4. Tag your new version at release commit
    • git tag v2.X.X
    • git push --tags
  5. Publish new version to NPM
  • Any unreleased functionality in master that's not been tagged should be highlighted in the "Unreleased" section of the changelog.

Questions?

Create an issue.