diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2f7247..0c9f36c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,50 +26,50 @@ accurate comments, etc.) and any other requirements (such as test coverage). Follow this process if you'd like your work considered for inclusion in the project: -1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, +* [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes: - ```bash - # Clone your fork of the repo into the current directory - git clone https://github.com// - # Navigate to the newly cloned directory - cd - # Assign the original repo to a remote called "upstream" - git remote add upstream https://github.com// - ``` +```bash +# Clone your fork of the repo into the current directory +git clone https://github.com// +# Navigate to the newly cloned directory +cd +# Assign the original repo to a remote called "upstream" +git remote add upstream https://github.com// +``` -2. If you cloned a while ago, get the latest changes from upstream: +* If you cloned a while ago, get the latest changes from upstream: - ```bash - git checkout - git pull upstream - ``` +```bash +git checkout +git pull upstream +``` -3. Create a new topic branch (off the main project development branch) to +* Create a new topic branch (off the main project development branch) to contain your feature, change, or fix: - ```bash - git checkout -b - ``` +```bash +git checkout -b +``` -4. Commit your changes in logical chunks. Please make your git commit message detailed and specific +* Commit your changes in logical chunks. Please make your git commit message detailed and specific or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public. -5. Locally merge (or rebase) the upstream development branch into your topic branch: +* Locally merge (or rebase) the upstream development branch into your topic branch: - ```bash - git pull [--rebase] upstream - ``` +```bash +git pull [--rebase] upstream +``` -6. Push your topic branch up to your fork: +* Push your topic branch up to your fork: - ```bash - git push origin - ``` +```bash +git push origin +``` -7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) +* [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description. **IMPORTANT**: By submitting a patch, you agree to allow the project owner to