Skip to content

Latest commit

History

History
36 lines (32 loc) 路 1.13 KB

CONTRIBUTING.md

File metadata and controls

36 lines (32 loc) 路 1.13 KB

Contributing Guide

Contributing to Reddit Bot is fairly easy. This document shows you how to get started.

Submitting changes

  • Fork the repo
  • Check out a new branch based and name it to what you intend to do:
    • Example:
      $ git checkout -b BRANCH_NAME feature/fooBar
      
      If you get an error, you may need to fetch fooBar first by using
      $ git remote update && git fetch
      
    • Use one branch per fix / feature
  • Commit your changes
    • Please provide a git message that explains what you've done.
    • Please make sure your commits follow the conventions
    • Commit to the forked repository.
    • Example:
      $ git commit -am 'Add some fooBar'
      
  • Push to the branch
    • Example:
      $ git push origin feature/fooBar
      
  • Make a pull request
    • Make sure you send the PR to the fooBar branch.
    • Travis CI is watching you!

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