How to Contribute (original) (raw)

Contributing

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.opensource.microsoft.com.

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., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Before Submitting an Issue

First, please do a search of open 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 yourreaction. Use a reaction in place of a "+1" comment.

👍 - upvote

👎 - downvote

If your issue is a question then please ask the question on Stack Overflowusing 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

Don't feel bad if we can't reproduce the issue and ask for more information!