Skip to content

Instantly share code, notes, and snippets.

@Overload119
Created January 26, 2019 19:56
Show Gist options
  • Save Overload119/598f915d08ce599cdf373ab8282278e2 to your computer and use it in GitHub Desktop.
Save Overload119/598f915d08ce599cdf373ab8282278e2 to your computer and use it in GitHub Desktop.
How to contribute to my projects.

Feature Workflow

You want to "branch"

git checkout master
git pull --rebase # sync your repo with Github.com
git checkout -b <yourbranchname> # create a branch and give it a unique name, usually after the feature (ie. "new-feature")
  • Makes changes in the code.
  • You can use git diff to see your changes.
  • When you want to commit them use git add . and then git commit -m <commmit message>
  • Try to make a commit for every small change.

Writing a good commit message:

Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Write “fix”, “add”, “change” instead of “fixed”, “added”, “changed”. Line break the commit message (to make the commit message readable without having to scroll horizontally in gitk). In your pull request talk about any Gem changes and Migrations/Schema changes and briefly describe your approach.

When your feature is completed run git push origin <yourbranchname> This will let us review it on Github. If the code looks good, we'll merge it into master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment