Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

71 lines (47 loc) · 2.44 KB
Raw

Contributing (Step-by-step, shamelessly cribbed from the Discourse project)

  1. Research the function(s) you want to add in the API documentation or if they aren't documented, learn how to reverse-engineer the Discourse API.

  2. Clone the Repo:

     git clone git://github.com/dhyasama/discourse-api.git

  3. Create a new Branch:

     cd discourse-api
 git checkout -b new_discourse-api_branch

Please keep your code clean: one feature or bug-fix per branch. If you find another bug, you want to fix while being in a new branch, please fix it in a separated branch instead.

  1. Code
  • Adhere to common conventions you see in the existing code
  • Include tests, and ensure they pass
  1. Commit

For every commit please write a short (max 72 characters) summary in the first line followed with a blank line and then more detailed descriptions of the change. Use markdown syntax for simple styling.

NEVER leave the commit message blank! Provide a detailed, clear, and complete description of your commit!

  1. Update your branch
git fetch origin
git rebase origin/master
  1. Fork
git remote add mine git@github.com:<your user name>/discourse-api.git
  1. Push to your remote
git push mine new_discourse-api_branch
  1. Issue a Pull Request

Before submitting a pull-request, clean up the history, go over your commits and squash together minor changes and fixes into the corresponding commits. You can squash commits with the interactive rebase command:

git fetch origin
git checkout new_discourse-api_branch
git rebase origin/master
git rebase -i

< the editor opens and allows you to change the commit history >
< follow the instructions on the bottom of the editor >

git push -f mine new_discourse-api_branch

In order to make a pull request,

  • Navigate to the Discourse repository you just pushed to (e.g. https://github.com/your-user-name/discourse-api)
  • Click "Pull Request".
  • Write your branch name in the branch field (this is filled with "master" by default)
  • Click "Update Commit Range".
  • Ensure the changesets you introduced are included in the "Commits" tab.
  • Ensure that the "Files Changed" incorporate all of your changes.
  • Fill in some details about your potential patch including a meaningful title.
  • Click "Send pull request".