Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 1.92 KB
Raw

Contributing to c8

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.

Issues

  • You can open issues here, please follow the template guide.
  • You can join the node-tooling/c8 channel, follow this link to request for an invite.

Pull Requests

Pull Requests are the way concrete changes are made to the code, documentation, dependencies, and tools contained in the c8 repository.

Setting up your local environment

  1. Make sure you have installed the latest version of Node.js

  2. 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

  3. Create local branches to work within. These should also be created directly off of the main branch:

    git checkout -b my-branch -t upstream/main

  4. Make your changes

  5. Run tests to make sure all is okay (everything should pass except snapshot):

    npm test

  6. Now update the snapshot

    npm run test:snap

  7. If all is passing, commit your changes.

  8. 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/main

  9. Run tests again to make sure all is okay

  10. Push:

    npm test

  11. Open the pull request, see details in the template.

  12. Make any necessary changes after review.

Note

This guide is adapted from the Node.js project, check it out for more details.