Skip to content
This repository has been archived by the owner on Aug 26, 2022. It is now read-only.

Latest commit

 

History

History
40 lines (24 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

40 lines (24 loc) · 1.03 KB

Contributing

PRs are always welcome!

If you're working on an existing issue, please leave a comment to let people know that it's in progress.

If you're adding new functionality, please update the docs to reflect this.

Setting up your environment

After forking this repo, do the following to get started:

# clone your fork to your local machine
git clone https://github.com/your-username/watch-github-labels.git

# step into local repo
cd watch-github-labels

# install dependencies
npm install

Running Tests

Please ensure all tests are passing, before making a PR.

# run the test suite
npm test

Coding Style

This project uses JavaScript Standard Style as a style guide/linter.

Please ensure your code complies with this, before making a PR. The website has a good list of editor plugins to help with this!

Having a style guide keeps things consistent across the project, and makes the code more readable.