Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 1.37 KB

contributing.md

File metadata and controls

26 lines (15 loc) · 1.37 KB

Contributing to basic-auth-token

Below are a few ways to make contributing to basic-auth-token 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/basic-auth-token.js.git
cd basic-auth-token.js
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 test output by running node test.

Style

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

Commits

When submitting pull requests please add a well-written and clear commit message and squash your commits. This means being familiar with rebasing - if you are not, this guide should help you to get started. If you are still confused, feel free to ask for help.