Adding new static code analysis rule template
This commit is contained in:
Родитель
09212f6e30
Коммит
aade5b6302
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
name: AL Static code analysis rule
|
||||
about: 'Suggesting a new Static code analysis rule for the AL compiler'
|
||||
title: ''
|
||||
labels: static-code-analysis
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Please follow this template in order for our to properly evlute the suggested rule.
|
||||
|
||||
Do not edit or remove the titles; e.g. "Descibe the bug".
|
||||
-->
|
||||
|
||||
**Title**
|
||||
Brief, descriptive string explaining the overall problem.
|
||||
|
||||
**Description**
|
||||
Longer, descriptive string, elaborating on the problem.
|
||||
|
||||
**Reason for the rule**
|
||||
Description of why this rule is important.
|
||||
|
||||
**Bad code sample**
|
||||
Example of what code the rule should catch:
|
||||
|
||||
``` Example of bad code ```
|
||||
|
||||
**Good code sample**
|
||||
Example of what code should look like:
|
||||
|
||||
``` Example of good code ```
|
||||
|
||||
**God and bad practices for fixing the rule**
|
||||
Description of good and bad solution to fixing this warning (only add this section if you have something additional information besides the good and bad code samples).
|
||||
|
||||
**Remarks**
|
||||
Add additional comments to the rule in this section.
|
Загрузка…
Ссылка в новой задаче