-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,14 @@ | ||
| ## Contributing Issues | ||
| # Contributing | ||
|
|
||
| ### Before Submitting an Issue | ||
| This project welcomes contributions and suggestions. Most contributions require you to | ||
| agree to a Contributor License Agreement (CLA) declaring that you have the right to, | ||
| and actually do, grant us the rights to use your contribution. For details, visit | ||
| https://cla.microsoft.com. | ||
|
|
||
| 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. | ||
|
|
||
| If you find your issue already exists, make relevant comments and add your | ||
| [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. | ||
|
|
||
| 👍 - upvote | ||
|
|
||
| 👎 - downvote | ||
|
|
||
| If your issue is a question then please ask the question on [Stack Overflow](https://stackoverflow.com/questions/tagged/devskim) | ||
| using the tag `devskim`. | ||
|
|
||
| If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. | ||
|
|
||
| ## Writing Good Bug Reports and Feature Requests | ||
|
|
||
| File a single issue per problem and feature request. | ||
|
|
||
| * Do not enumerate multiple bugs or feature requests in the same issue. | ||
| * 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. | ||
| * Turning on `debug` mode can be helpful in providing more information (Package Settings | DevSkim | Settings - User | set `"debug": true`) | ||
|
|
||
| The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. Therefore: | ||
|
|
||
| * Provide reproducible steps, what the result of the steps was, and what you would have expected. | ||
| * A description of what you expect to happen | ||
| * Code that demonstrates the issue, when providing a code snippet also include it in source and not only as an image | ||
| * Version of DevSkim and Sublime Text | ||
| * Errors in the Sublime Text Console (View | Show Console) | ||
|
|
||
| Don't feel bad if we can't reproduce the issue and ask for more information! | ||
|
|
||
| ## Contributing Fixes | ||
|
|
||
| If you are interested in fixing issues and contributing directly to the code base, | ||
| please see the document [How to Contribute](https://github.com/Microsoft/DevSkim/wiki/How-to-Contribute). | ||
| When you submit a pull request, a CLA-bot will automatically determine whether you need | ||
| to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the | ||
| instructions provided by the bot. You will only need to do this once across all repositories using our CLA. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
| or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |