aboutsummaryrefslogblamecommitdiff
path: root/CONTRIBUTING.md
blob: 4aaed87fd80d314b8f70c7480961a981764797dd (plain) (tree)
1
2
3
4
5
6
7
8
9



                                                              
 



                                                  
 

                    
                                
   
 



                         
 






                          
 








                                                                                           
# Contributing
We love pull requests from everyone.
By participating in this project, you agree to abide by the
[code of conduct](https://opensource.guide/how-to-contribute).

Fork, then clone the repo:
```bash
git clone git@github.com:<username>/iii-client.git
```

Set up your machine:
```bash
NODE_ENV=development npm install
```

Make sure the tests pass:
```bash
npm run test
```

Make your change.
Add tests for your change.
Make the tests pass:
```bash
npm run check
npm run test
```

Push to your fork and
[submit a pull request](https://github.com/valentineus/iii-client/compare).

Some things that will increase the chance that your pull request is accepted:
* Write tests.
* Follow our
[style guide](https://eslint.org/docs/about).
* Write a
[good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).