|
| 1 | +# Contributing to [project-title] |
| 2 | + |
| 3 | +This project welcomes contributions and suggestions. Most contributions require you to agree to a |
| 4 | +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us |
| 5 | +the rights to use your contribution. For details, visit https://cla.microsoft.com. |
| 6 | + |
| 7 | +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide |
| 8 | +a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions |
| 9 | +provided by the bot. You will only need to do this once across all repos using our CLA. |
| 10 | + |
| 11 | +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
| 12 | +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
| 13 | +contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |
| 14 | + |
| 15 | + - [Code of Conduct](#coc) |
| 16 | + - [Issues and Bugs](#issue) |
| 17 | + - [Feature Requests](#feature) |
| 18 | + - [Submission Guidelines](#submit) |
| 19 | + |
| 20 | +## <a name="coc"></a> Code of Conduct |
| 21 | +Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
| 22 | + |
| 23 | +## <a name="issue"></a> Found an Issue? |
| 24 | +If you find a bug in the source code or a mistake in the documentation, you can help us by |
| 25 | +[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can |
| 26 | +[submit a Pull Request](#submit-pr) with a fix. |
| 27 | + |
| 28 | +## <a name="feature"></a> Want a Feature? |
| 29 | +You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub |
| 30 | +Repository. If you would like to *implement* a new feature, please submit an issue with |
| 31 | +a proposal for your work first, to be sure that we can use it. |
| 32 | + |
| 33 | +* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). |
| 34 | + |
| 35 | +## <a name="submit"></a> Submission Guidelines |
| 36 | + |
| 37 | +### <a name="submit-issue"></a> Submitting an Issue |
| 38 | +Before you submit an issue, search the archive, maybe your question was already answered. |
| 39 | + |
| 40 | +If your issue appears to be a bug, and hasn't been reported, open a new issue. |
| 41 | +Help us to maximize the effort we can spend fixing issues and adding new |
| 42 | +features, by not reporting duplicate issues. Providing the following information will increase the |
| 43 | +chances of your issue being dealt with quickly: |
| 44 | + |
| 45 | +* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps |
| 46 | +* **Version** - what version is affected (e.g. 0.1.2) |
| 47 | +* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you |
| 48 | +* **Browsers and Operating System** - is this a problem with all browsers? |
| 49 | +* **Reproduce the Error** - provide a live example or a unambiguous set of steps |
| 50 | +* **Related Issues** - has a similar issue been reported before? |
| 51 | +* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be |
| 52 | + causing the problem (line of code or commit) |
| 53 | + |
| 54 | +You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new]. |
| 55 | + |
| 56 | +### <a name="submit-pr"></a> Submitting a Pull Request (PR) |
| 57 | +Before you submit your Pull Request (PR) consider the following guidelines: |
| 58 | + |
| 59 | +* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR |
| 60 | + that relates to your submission. You don't want to duplicate effort. |
| 61 | + |
| 62 | +* Make your changes in a new git fork: |
| 63 | + |
| 64 | +* Commit your changes using a descriptive commit message |
| 65 | +* Push your fork to GitHub: |
| 66 | +* In GitHub, create a pull request |
| 67 | +* If we suggest changes then: |
| 68 | + * Make the required updates. |
| 69 | + * Rebase your fork and force push to your GitHub repository (this will update your Pull Request): |
| 70 | + |
| 71 | + ```shell |
| 72 | + git rebase master -i |
| 73 | + git push -f |
| 74 | + ``` |
| 75 | + |
| 76 | +That's it! Thank you for your contribution! |
0 commit comments