Contributing

Thank you for wanting to help make cheer-reader better!

For outstanding issues, see the issue list in this repo.

To test local changes, you can use the automated tests.

Tests

Please run eslint as a first check that your changes are valid JS and adhere to our style guidelines:

$ npm run lint

To run the test suite:

$ npm test

To run a specific test page by its name:

$ npm test -- -g 001

To run the test suite in TDD mode:

$ npm test -- -w

Combo time:

$ npm test -- -w -g 001

There's a node script to help you create new tests. You can run it using:

$ node test/generate-testcase.js slug https://example.com/article

Replacing slug with the identifier the test should use, and providing a URL to an actual article on which the test should be based.

We're always happy to see pull requests to improve cheer-reader.

Please ensure you run the linter and tests before submitting a PR.

If you're changing the algorithm to fix a specific page/article, please add new tests for the case you're fixing, so we avoid breaking it in future.

Ensure CHANGELOG.md is up-to-date. git log `npm view . version`...master may help with this.
Run npm run release to create a release, which should: 1. npm version [patch | minor | major], depending on the nature of the changes according to semver. This will bump the version in package.json and package-lock.json and create a commit and Git tag for the release. 2. npm publish to push the release to the npm registry. 3. git push origin head --follow-tags to push the new commit and tag to GitHub.

Ensure significant changes are added to CHANGELOG.md. Do not add changes that only affect tests or documentation.