Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 1.2 KB

Contributing Guide

Contributing to osseus-server is fairly easy.

Check out the README on how to get the project, run all provided tests and generate a production-ready build.

Contributing/Submitting changes

  • Check out a new branch based on master and name it to what you intend to do:

    • Example:

      $ git checkout -b BRANCH_NAME origin/master
      

      If you get an error, you may need to fetch master first by using

      $ git remote update && git fetch
      
    • Use one branch per fix/feature

  • Make your changes

    • Make sure to provide a spec for unit tests.
    • In order to verify everything will work please run npm test.
    • When all tests pass, everything's fine.
  • Commit your changes

    • Please provide a git message that explains what you've done.
    • Commit to the forked repository.
  • Make a pull request

    • Make sure you use the PR template
    • Make sure you send the PR to the master branch.

If you follow these instructions, your PR will land pretty safely in the main repo!