-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Split contributing guide into separate file (#46)
- Loading branch information
1 parent
cb089a1
commit 3427bdf
Showing
2 changed files
with
16 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## Contributing | ||
|
||
* Make sure your changes pass the unit tests! | ||
* To run the tests locally, run: | ||
|
||
```js | ||
npm install | ||
npm run test | ||
``` | ||
|
||
* We use the [Standard](https://standardjs.com/) style guide | ||
* Run `npm run fix` to automatically format code to comply with the style guide | ||
* Don't feel pressured to code in Standard! Just run `npm run fix` | ||
* When adding a new feature, please add a unit test in `/test/test.js` | ||
* If you have any suggestions regarding our workflow, please feel free to open an issue :smile: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters