diff options
author | Safia Abdalla <safia@microsoft.com> | 2022-11-11 04:35:11 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-11-11 04:35:11 +0300 |
commit | 15a71447bdcb9e3cdcb287c66441598980b817d4 (patch) | |
tree | c1ac71b11e652276c24b35cbb14b2262a03be06a | |
parent | 916c1a43630bb0c9839c6ce5e2972ca6e623c7ab (diff) |
Add template for analyzer/codefixer proposals (#45009)
* Add template for analyzer proposals
* Fix typo
* Apply suggestions from code review
Co-authored-by: James Newton-King <james@newtonking.com>
* Apply suggestions from code review
Co-authored-by: Stephen Halter <halter73@gmail.com>
Co-authored-by: James Newton-King <james@newtonking.com>
Co-authored-by: Stephen Halter <halter73@gmail.com>
-rw-r--r-- | .github/ISSUE_TEMPLATE/60_analyzer_proposal.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/60_analyzer_proposal.md b/.github/ISSUE_TEMPLATE/60_analyzer_proposal.md new file mode 100644 index 0000000000..cafd30cf09 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/60_analyzer_proposal.md @@ -0,0 +1,69 @@ +--- +name: Analyzer proposal +about: Propose a new analyzer/codefixer or an update to an existing one +title: '' +labels: api-suggestion, analyzer +assignees: '' +--- + +## Background and Motivation + +<!-- +We welcome new analyzers and codefixers in the ASP.NET repo! + +We use the same process to review both new analyzer/codefixer submissions and API proposals. There is an overview of our process [here](https://github.com/dotnet/aspnetcore/blob/main/docs/APIReviewProcess.md). This template will help us gather the information we need to start the review process. + +Under this heading, describe the problem that your analyzer is trying to solve. Examples of great motivating scenarios include helping users avoid +performance issues, potentially insecure code, or recommending better APIs for a scenario. +--> + +## Proposed Analyzer + +### Analyzer Behavior and Message + +<!-- +Provide a description of when the analyzer will trigger and the associated analyzer message. +--> + +<!-- +Analyzer categories are derived from the categories documented in https://learn.microsoft.com/dotnet/fundamentals/code-analysis/categories +To select a category, review each category's description and select the best category based on the functionality of your analyzer. + +Analyzer severity levels are documented in https://learn.microsoft.com/visualstudio/code-quality/use-roslyn-analyzers#configure-severity-levels +Review the description to observe how the level set on the analyzer will affect build-time and editor behavior and select the best +level for the task. +--> + +### Category + +- [ ] Design +- [ ] Documentation +- [ ] Globalization +- [ ] Interoperability +- [ ] Maintainability +- [ ] Naming +- [ ] Performance +- [ ] Reliability +- [ ] Security +- [ ] Style +- [ ] Usage + +### Severity Level + +- [ ] Error +- [ ] Warning +- [ ] Info +- [ ] Hidden + +## Usage Scenarios + +<!-- +Provide code examples that would trigger your analyzer to warn. Identify the spans of code that the analyzer +will be triggered on. When applicable, describe the result of the code fix associated with the change. +--> + +## Risks + +<!-- +Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc. +--> |