The c8 project welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued.
- You can open issues here, please follow the template guide.
- You can join the
node-tooling/c8channel, follow this link to request for an invite.
Pull Requests are the way concrete changes are made to the code, documentation, dependencies, and tools contained in the c8 repository.
- Make sure you have installed the latest version of Node.js
- Fork this project on Github and clone your fork locally:
$ git clone [email protected]:username/c8.git
$ cd c8
$ git remote add upstream https://github.com/bcoe/c8.git
$ git fetch upstream
- Create local branches to work within. These should also be created directly off of the master branch:
$ git checkout -b my-branch -t upstream/master
- Make your changes
- Run tests to make sure all is okay (everything should pass except snapshot):
$ npm test
- Now update the snapshot
$ npm run test:snap
- If all is passing, commit your changes.
- As a best practice, once you have committed your changes, it is a good idea to use git rebase (not git merge) to synchronize your work with the main repository:
$ git fetch upstream
$ git rebase upstream/master
- Run tests again to make sure all is okay
- Push:
$ npm test
- Open the pull request, see details in the template.
- Make any necessary changes after review.
This guide is adapted from the Node.js project, check it out for more details.