|
1 | | -## Contributing Issues |
| 1 | +# Contributing |
2 | 2 |
|
3 | | -### Before Submitting an Issue |
| 3 | +This project welcomes contributions and suggestions. Most contributions require you to |
| 4 | +agree to a Contributor License Agreement (CLA) declaring that you have the right to, |
| 5 | +and actually do, grant us the rights to use your contribution. For details, visit |
| 6 | +https://cla.microsoft.com. |
4 | 7 |
|
5 | | -First, please do a search of [open issues](https://github.com/Microsoft/DevSkim/issues) to see if the issue or feature request has already been filed. |
6 | | - |
7 | | -If you find your issue already exists, make relevant comments and add your |
8 | | -[reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. |
9 | | - |
10 | | -👍 - upvote |
11 | | - |
12 | | -👎 - downvote |
13 | | - |
14 | | -If your issue is a question then please ask the question on [Stack Overflow](https://stackoverflow.com/questions/tagged/devskim) |
15 | | -using the tag `devskim`. |
16 | | - |
17 | | -If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. |
18 | | - |
19 | | -## Writing Good Bug Reports and Feature Requests |
20 | | - |
21 | | -File a single issue per problem and feature request. |
22 | | - |
23 | | -* Do not enumerate multiple bugs or feature requests in the same issue. |
24 | | -* 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. |
25 | | -* Turning on `debug` mode can be helpful in providing more information (Package Settings | DevSkim | Settings - User | set `"debug": true`) |
26 | | - |
27 | | -The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. Therefore: |
28 | | - |
29 | | -* Provide reproducible steps, what the result of the steps was, and what you would have expected. |
30 | | -* A description of what you expect to happen |
31 | | -* Code that demonstrates the issue, when providing a code snippet also include it in source and not only as an image |
32 | | -* Version of DevSkim and Sublime Text |
33 | | -* Errors in the Sublime Text Console (View | Show Console) |
34 | | - |
35 | | -Don't feel bad if we can't reproduce the issue and ask for more information! |
36 | | - |
37 | | -## Contributing Fixes |
38 | | - |
39 | | -If you are interested in fixing issues and contributing directly to the code base, |
40 | | -please see the document [How to Contribute](https://github.com/Microsoft/DevSkim/wiki/How-to-Contribute). |
| 8 | +When you submit a pull request, a CLA-bot will automatically determine whether you need |
| 9 | +to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the |
| 10 | +instructions provided by the bot. You will only need to do this once across all repositories using our CLA. |
41 | 11 |
|
| 12 | +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
| 13 | +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) |
| 14 | +or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
0 commit comments