Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (38 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 1.63 KB

Contributing

Issues

You can find our open issues in the project's issue tracker. Please let us know if you find any issues or have any feature requests there.

Pull requests

A pull request must contain a linked issue, its title should explain the issue or feature shortly and clearly.

CI check

The check script collects the scripts which are run by the CI workflow. The CI workflow invokes the check-prettier and the check-eslint scripts.

npm run check

Formatting

The write-npmstat project is formatted with prettier. Run the check-prettier script to check that the js files are formatted with prettier.

npm run check-prettier

prettier can be run with the prettier script.

npm run prettier

Linter

The eslint script runs eslint over the write-npmstat project.

npm run eslint

Release

write-npmstat is distributed on npmjs.

Changes

If your changes are ready to release, you should increase the version number in package.json. The version bump should be in a separated commit and the commit message should be in the following format:

'package.json: version x.y.z'

New release should be created on github.

Note: Release notes are auto-generated from closed pull requests.

Package

Publishing a new release will automatically trigger the Release workflow which builds and uploads the write-npmstat package to npmjs.