| 1 | Contributing
|
| 2 | ============
|
| 3 |
|
| 4 | If you wish to contribute please read the following quick guide.
|
| 5 |
|
| 6 | # Want a Feature?
|
| 7 | You can request a new feature by submitting an issue. If you would like to implement a new feature feel free to issue a
|
| 8 | Pull Request.
|
| 9 |
|
| 10 |
|
| 11 | # Pull requests (PRs)
|
| 12 | PRs are awesome. However, before you submit your pull request consider the following guidelines:
|
| 13 |
|
| 14 | - Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
|
| 15 | - When issuing PRs that change code, make your changes in a new git branch based on master:
|
| 16 |
|
| 17 | ```bash
|
| 18 | git checkout -b my-fix-branch master
|
| 19 | ```
|
| 20 |
|
| 21 | - Documentation (i.e: README.md) changes can be made directly against master.
|
| 22 | - Run the full test suite before submitting and make sure all tests pass (obviously =P).
|
| 23 | - Try to follow our [**coding style rules**](https://github.com/showdownjs/code-style/blob/master/README.md).
|
| 24 | Breaking them prevents the PR to pass the tests.
|
| 25 | - Refrain from fixing multiple issues in the same pull request. It's preferable to open multiple small PRs instead of one
|
| 26 | hard to review big one. Also, don't reuse old forks (or PRs) to fix new issues.
|
| 27 | - If the PR introduces a new feature or fixes an issue, please add the appropriate test case.
|
| 28 | - We use commit notes to generate the changelog. It's extremely helpful if your commit messages adhere to the
|
| 29 | [**AngularJS Git Commit Guidelines**](https://github.com/showdownjs/code-style/blob/master/README.md#commit-message-convention).
|
| 30 | - If we suggest changes then:
|
| 31 | - Make the required updates.
|
| 32 | - Re-run the Angular test suite to ensure tests are still passing.
|
| 33 | - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
|
| 34 |
|
| 35 | ```bash
|
| 36 | git rebase master -i
|
| 37 | git push origin my-fix-branch -f
|
| 38 | ```
|
| 39 | - After your pull request is merged, you can safely delete your branch.
|
| 40 |
|
| 41 | If you have time to contribute to this project, we feel obliged that you get credit for it.
|
| 42 | These rules enable us to review your PR faster and will give you appropriate credit in your GitHub profile.
|
| 43 | We thank you in advance for your contribution!
|
| 44 |
|
| 45 |
|
| 46 | # Joining the team
|
| 47 | We're looking for members to help maintaining Showdown.
|
| 48 | Please see [this issue](https://github.com/showdownjs/showdown/issues/114) to express interest or comment on this note.
|
| 49 | |
| \ | No newline at end of file |