Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Charlie Lee committed Apr 29, 2016
1 parent 6f35bee commit fcd766e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Thank you for choosing to help improve Boats Animator!

## Setup
1. First fork this repository by pressing ![Fork](https://camo.githubusercontent.com/07b3944af53da32b0cffe98152c45c46431a82f0/687474703a2f2f6938312e73657276696d672e636f6d2f752f6638312f31362f33332f30362f31312f666f726b6d6531322e706e67)
2. Clone the fork to your computer using: `git clone https://github.com/BoatsAreRockable/Boats-Animator.git` or [GitHub Desktop](https://desktop.github.com/).
2. Clone the fork to your computer using: `git clone https://github.com/YOUR_USERNAME/Boats-Animator.git` or [GitHub Desktop](https://desktop.github.com/).
3. Install **version 5+** of [Node.js](https://nodejs.org/en/download/stable/).
4. Navigate to the `animator/app` directory and run: `npm install`.

Expand All @@ -16,13 +16,13 @@ Alternatively, download version **0.14.2** of [NW.js](http://nwjs.io/) and follo

## Reporting issues
If you find a bug or want to suggest an improvement:
* First check someone else hasn't already reported it in the [issues](https://github.com/BoatsAreRockable/animator/issues) section.
* If not, create a [new issue](https://github.com/BoatsAreRockable/animator/issues/new) for it.
* First check someone else hasn't already reported it in the [issues](https://github.com/BoatsAreRockable/Boats-Animator/issues) section.
* If not, create a [new issue](https://github.com/BoatsAreRockable/Boats-Animator/issues/new) for it.
* Please make sure to include a clear **title** and **description** as well as any relevant error messages, code snippets or screenshots.

## Submitting Changes
If you're working on an improvement to Boats Animator it is usually good practise to add a comment to the [relevant issue](https://github.com/BoatsAreRockable/animator/issues). Once you are ready to submit your change you should:
* Create a [new pull Request](https://github.com/BoatsAreRockable/animator/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)).
If you're working on an improvement to Boats Animator it is usually good practise to add a comment to the [relevant issue](https://github.com/BoatsAreRockable/Boats-Animator/issues). Once you are ready to submit your change you should:
* Create a [new pull Request](https://github.com/BoatsAreRockable/Boats-Animator/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)).
* The pull request should reference any relevant issues and have a clear title.
* The log messages for any commits should also be clear.
* The coding conventions for Boats Animator should be followed.
Expand Down

0 comments on commit fcd766e

Please sign in to comment.