Skip to content

Latest commit

 

History

History
40 lines (36 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

40 lines (36 loc) · 1.1 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/parse-md.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
    git fetch upstream
    git rebase 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 __tests__/ folder. Here's how to run them:

npm test