Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.05 KB

contributing.md

File metadata and controls

56 lines (37 loc) · 2.05 KB

Contributing to wd-selenium-hooks

Below are a few ways to make contributing to wd-selenium-hooks smoother.

Issues

When opening an issue for a bug, please include steps for reproducing the problem. If we can't reproduce it, we can't fix it. If you are suggesting a new feature, please provide a clear and detailed explanation.

Setup

git clone https://github.com/wilmoore/node-wd-selenium-hooks.git
cd node-wd-selenium-hooks
npm install
npm run dev

Tests

If you are adding a new feature, please include tests. The test suite for this project uses tape. To run the test suite, type npm test. You may also run the development watcher (npm run dev) which uses nodemon to re-run the test suite when files are modified. You can also get the raw tap output by running node test.

Style

To keep a consistent coding style in the project, we're using JavaScript Standard Style.

npm run standard

This command will be run automatically with npm run dev; however, you can run it on-demand as necessary.

Dependencies

To ensure that (1) we are not depending on uninstalled packages and (2) we haven't installed any unused packaged, we're using dependency-check.

npm run dependency-check

This command will be run automatically with npm run dev; however, you can run it on-demand as necessary.

Package

To keep a consistent package.json, we're using fixpack.

npm run fixpack

Commits

When submitting pull requests please add a well-written and clear commit message and squash your commits. This means being familiar with interactive rebasing.