Contributing

May 16, 2018 ยท View on GitHub

First of all, thank you for your interest in contributing to headless-chrome-crawler! When contributing to this project, please first discuss the change you wish to make via issue before making a change.

Please note that this project has a code of conduct, please follow it in all your interactions with this project.

Contributing Process

  1. Modify code following ESLint and the code should be annotated with JSDoc annotations.
  2. Make sure all tests are passed by yarn test (or run yarn test-all when you modify the RedisCache's code). Modify tests when the interface has changed.
  3. Update the README.md with details of changes to the interface.
  4. Update the CHANGELOG.md. The versioning scheme we use is Semantic Versioning.
  5. Make your commit message following Conventional Commits.
  6. Make a Pull Request and you may request a reviewer to merge your commit.