Our process for accepting changes operates by Pull Request (PR) and has a few steps:
-
If you haven't submitted anything before, and you aren't (yet!) a member of our organization, fork and clone the repo:
$ git clone git@github.com:<your-username>/<repository-name>.git
Organization members should clone the upstream repo, instead of working from a personal fork:
$ git clone git@github.com:chatair/<repository-name>.git
-
Create a new branch for the changes you want to work on. Choose a topic for your branch name that reflects the change:
$ git checkout -b <branch-name>
-
Create or modify the files with your changes. If you want to show other people work that isn't ready to merge in, commit your changes then create a pull request (PR) with WIP or Work In Progress in the title.
https://github.com/chatair/<repository-name>/pull/new/master
-
Once your changes are ready for final review, commit your changes then modify or create your pull request (PR), assign as a reviewer or ping (using "
@<username>
") a Lieutenant (someone able to merge in PRs) active on the project (all Lieutenants can be pinged via@chatair/lieutenants
) -
Allow others sufficient time for review and comments before merging. We make use of GitHub's review feature to comment in-line on PRs when possible. There may be some fixes or adjustments you'll have to make based on feedback.
-
Once you have integrated comments, or waited for feedback, a Lieutenant should merge your changes in!
Commit messages should be in the following format:
#<issue-number> A brief description of changes on one line
- Don't use Hungarian Notation like
mContext
mCount
etc - Don't use underscores in variable names
- All constants should be CAPS. e.g
MINIMUM_TIMEOUT_ERROR_EXTERNAL