Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

62 lines (46 loc) · 2.37 KB
Raw

Contributing

Thanks for being willing to contribute!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project setup

  1. Fork and clone the repo
  2. Run npm install to install dependencies
  3. Create a branch for your PR with git checkout -b pr/your-branch-name

Tip: Keep your master branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/cornerstonejs/cornerstoneTools.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local master branch to use the upstream master branch whenever you run git pull. Then you can make all of your pull request branches based on this master branch. Whenever you want to update your version of master, do a regular git pull.

Add yourself as a contributor

This project follows the all contributors specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

npm run contributors:add

Follow the prompt and commit .all-contributorsrc and README.md in the PR. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type.

Committing and Pushing changes

  • Verify new code does not break existing tests
    • npm run test
  • Commit staged changes
    • npm run commit
  • Create a pull request from your branch to upstream's master, feature, or hotfix branch

Help needed

Please checkout the the open issues

Also, please watch the repo and respond to questions, bug reports, and/or feature requests! Thanks!

Final Note: This is Open Source! Anything/everything can be improved through collaberation and iteration. That includes this CONTRIBUTING.md guide. Please feel free to raise issues and create pull requests for anything ^_^