Skip to content

Latest commit

 

History

History
45 lines (40 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

45 lines (40 loc) · 1.15 KB

Contributing

  1. Check out the issues
  2. Fork this repository
  3. Clone your fork
  4. Add the upstream project (this one) as a git remote:
    $ git remote add upstream git@github.com:rpearce/hex.git
    $ git fetch upstream
    $ git rebase upstream/main
    
  5. Check out a feature branch
    $ git checkout -b my-feature
    
  6. Make your changes
  7. Push your branch to your GitHub repo
    $ git push origin my-feature
    
  8. Create a pull request from your branch to this repo's main branch
  9. When all is merged, pull down the upstream changes to your main branch
    $ git fetch upstream
    $ git merge upstream/main
    
  10. Delete your feature branch (locally and then on GitHub)
    $ git branch -D my-feature
    $ git push origin :my-feature
    

Testing

Tests are located in the test/ folder. Here's how to run them:

$ yarn test

To watch for changes:

$ yarn test --watch