|
| 1 | +##Contributing## |
| 2 | + |
| 3 | +Where to start |
| 4 | + |
| 5 | +There are many different ways to contribute to **rest-api-node-typescript**'s development, just find the one that best fits with your skills. Examples of contributions we would love to receive include: |
| 6 | + |
| 7 | + - Code patches [pull request](https://help.github.com/articles/creating-a-pull-request/) |
| 8 | + - Documentation improvements |
| 9 | + - Translations(yet to come) |
| 10 | + - Bug reports |
| 11 | + - Patch reviews |
| 12 | + - UI enhancements |
| 13 | + |
| 14 | +When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owners of this repository before making a change. |
| 15 | + |
| 16 | +Please note we have a code of conduct, please follow it in all your interactions with the project. |
| 17 | + |
| 18 | +##Reporting Issues## |
| 19 | + |
| 20 | +Have you identified a reproducible problem in this repo? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible. |
| 21 | + |
| 22 | +##Look For an Existing Issue## |
| 23 | +Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed. |
| 24 | + |
| 25 | +Be sure to scan through the most popular feature requests. |
| 26 | + |
| 27 | +If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment: |
| 28 | + |
| 29 | +👍 - upvote |
| 30 | + |
| 31 | +👎 - downvote |
| 32 | + |
| 33 | +If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. |
| 34 | + |
| 35 | +##Writing Good Bug Reports and Feature Requests## |
| 36 | +File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue. |
| 37 | + |
| 38 | +Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar but have different causes. |
| 39 | + |
| 40 | +The more information you can provide, the more likely someone will be successful in reproducing the issue and finding a fix. |
| 41 | + |
| 42 | +Please include the following with each issue: |
| 43 | + |
| 44 | +- OS |
| 45 | +- The version of Node.js, npm / yarn |
| 46 | +- Reproducible steps (1... 2... 3...) that cause the issue |
| 47 | +- What you expected to see, versus what you actually saw |
| 48 | +- Images, animations, or a link to a video showing the issue occurring |
| 49 | +- A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally |
| 50 | + - **Note**: Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient. |
| 51 | +- Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools) |
| 52 | + |
| 53 | +##Thank You!## |
| 54 | +Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute. |
0 commit comments