Organizer contribution guidelines - GothamSass/chrysler GitHub Wiki

in progress

These guidelines are for users with commit access to the repo. If you do not have commit access, refer to contributing.

Create a branch

  1. git checkout -b <branch-name> where branch-name should describe what you're working on
  2. Do some work. Add your files. git commit <file-name>. If you don't pass the -m flag, you will be prompted to leave a message.

Opening a pull request

  1. Go to https://github.com/GothamSass/chrysler/compare/
  2. Select base branch. More often than not it will be gh-pages
  3. Select the branch you were working on from the compare dropdown
  4. Now, click `create pull request``, a form will appear.
  5. Give your PR a meaningful title. If you are creating a PR before the feature is complete append (WIP) to your title
  6. Enter a description. If you work resolves an issue, enter the issue #
  7. Finally, create pull request. Huzzah!

General Guidelines

  • Commit often. Meaningful small commits are better than one large one and make it easier to revert work.
  • Leave detailed commit messages
  • Open a pull request early on. It is easier for everyone to follow along.
⚠️ **GitHub.com Fallback** ⚠️