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