|
| 1 | +# Contributing to vscode-nestjs-snippets |
| 2 | + |
| 3 | +We would love for you to contribute and help make it even better |
| 4 | +than it is today! As a contributor, here are the guidelines we would like you |
| 5 | +to follow: |
| 6 | + |
| 7 | +-[Code of Conduct](#coc) |
| 8 | + - [Issues and Bugs](#issue) |
| 9 | + - [Feature Requests](#feature) |
| 10 | + - [Submission Guidelines](#submit) |
| 11 | + |
| 12 | +## <a name="coc" > </a> Code of Conduct |
| 13 | +Help us keep this project open and inclusive.Please read and follow our [Code of Conduct](code_of_conduct /). |
| 14 | + |
| 15 | +## <a name="issue" > </a> Found an Issue? |
| 16 | +If you find a bug in the source code or a mistake in the documentation, you can help us by |
| 17 | +[submitting an issue](#submit - issue) to our [GitHub Repository](https://github.com/ashinzekene/vscode-nestjs-snippets). Even better, you can |
| 18 | + [submit a Pull Request](#submit-pr) with a fix. |
| 19 | + |
| 20 | +## <a name="feature" > </a> Want a Feature? |
| 21 | +You can * request * a new feature by [submitting an issue](#submit - issue) to our [GitHub |
| 22 | +Repository][github].If you would like to * implement * a new feature, please submit an issue with |
| 23 | +a proposal for your work first, to be sure that we can use it. |
| 24 | + |
| 25 | +* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit - pr). |
| 26 | + |
| 27 | +## <a name="submit" > </a> Submission Guidelines |
| 28 | + |
| 29 | +### <a name="submit-issue" > </a> Submitting an Issue |
| 30 | +Before you submit an issue, search the archive, maybe your question was already answered. |
| 31 | + |
| 32 | +If your issue appears to be a bug, and hasn't been reported, open a new issue. |
| 33 | +Help us to maximize the effort we can spend fixing issues and adding new |
| 34 | + features, by not reporting duplicate issues.Providing the following information will increase the |
| 35 | +chances of your issue being dealt with quickly: |
| 36 | + |
| 37 | +* **Overview of the Issue** - if an error is being thrown a non- minified stack trace helps |
| 38 | + * **Version ** - what version is affected (e.g. 0.1.2) |
| 39 | + * **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you |
| 40 | + * **Browsers and Operating System** - is this a problem with all browsers? |
| 41 | +* **Reproduce the Error** - provide a live example [Runnable][runnable]) or a unambiguous set of steps |
| 42 | + * **Related Issues** - has a similar issue been reported before? |
| 43 | +* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be |
| 44 | +causing the problem (line of code or commit) |
| 45 | + |
| 46 | +You can file new issues by providing the above information [here](https://github.com/ashinzekene/vscode-nestjs-snippets/issues/new). |
| 47 | + |
| 48 | + ### <a name="submit-pr" > </a> Submitting a Pull Request (PR) |
| 49 | +Before you submit your Pull Request (PR) consider the following guidelines: |
| 50 | + |
| 51 | +* Search[GitHub](https://github.com/ashinzekene/vscode-nestjs-snippets/pulls) for an open or closed PR |
| 52 | + that relates to your submission.You don't want to duplicate effort. |
| 53 | + |
| 54 | + * Make your changes in a new git fork: |
| 55 | + |
| 56 | +* Commit your changes using a descriptive commit message |
| 57 | + * Push your fork to GitHub: |
| 58 | +* In GitHub, send a pull request |
| 59 | + * If we suggest changes then: |
| 60 | + * Make the required updates. |
| 61 | + * Rebase your fork and force push to your GitHub repository (this will update your Pull Request): |
| 62 | + |
| 63 | + ```shell |
| 64 | + git rebase master -i |
| 65 | + git push -f |
| 66 | + ``` |
| 67 | + |
| 68 | +That's it! Thank you for your contribution! |
0 commit comments