Skip to content

Commit ce0d607

Browse files
author
Per Kops
committedDec 7, 2020
Fix spelling and layout mistakes
1 parent baf188a commit ce0d607

13 files changed

+131
-90
lines changed
 

‎documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/CA1707.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
1-
# Rule suppress suggestion - Decision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
05-12-2020
78

89
### ATC Core members in meeting
10+
911
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1012
* [Per](https://github.com/orgs/atc-net/people/perkops)
1113

1214
### Rule summary
13-
| Key | Value |
15+
16+
| | Value |
1417
| ----------- |------------------------------------------------|
1518
| Title | CA1707 Identifiers should not contain underscores |
1619
| CheckId | CA1707 |
1720
| Category | Microsoft.Naming |
1821
| Link | https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1707 |
1922

2023
### What is the problem
24+
2125
[Issue #2](https://github.com/atc-net/atc-coding-rules/issues/2)
2226

2327
### Decision
28+
2429
Just follow the rule for code project - see 'How to fix violations'
2530

2631
For test project we update the sub-located `test/.editorconfig` with a doc-link.
2732

2833
### Reason & arguments
34+
2935
* We like the argument from Microsoft for code project
3036
* For test project we like the options for using underscores in method names
31-

‎documentation/CodeAnalyzersRules/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Rules suppression overview
2+
3+
## [AsyncFixer](http://www.asyncfixer.com)
4+
5+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
6+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
7+
| | | | | | |
8+
9+
## [Asyncify](https://github.com/hvanbakel/Asyncify-CSharp)
10+
11+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
12+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
13+
| | | | | | |
14+
15+
## [Meziantou](https://www.meziantou.net/enforcing-asynchronous-code-good-practices-using-a-roslyn-analyzer.htm)
16+
17+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
18+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
19+
| | | | | | |
20+
21+
## [Microsoft - Code Analysis](https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules)
22+
23+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
24+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
25+
| CA1707 | | 04-12-2020 | Y | test | [link](/documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/CA1707.md) |
26+
27+
## [Microsoft - FxCop](https://github.com/dotnet/roslyn-analyzers)
28+
29+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
30+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
31+
| | | | | | |
32+
33+
## [Microsoft - Threading](https://github.com/microsoft/vs-threading/blob/master/doc/analyzers/index.md)
34+
35+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
36+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
37+
| | | | | | |
38+
39+
## [SecurityCodeScan](https://security-code-scan.github.io)
40+
41+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
42+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
43+
| | | | | | |
44+
45+
## [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers)
46+
47+
| Rule | Area | Decision Date | Suppressed Y/N | Location | Decision link |
48+
| ----------- |-------------------|:-------------:|:--------------:|:--------:|---------------|
49+
| SA1101 | Documentation | 04-12-2020 | Y | root | [link](/documentation/CodeAnalyzersRules/StyleCop/SA1101.md) |
50+
| SA1200 | Documentation | 04-12-2020 | Y | root | [link](/documentation/CodeAnalyzersRules/StyleCop/SA1200.md) |
51+
| SA1413 | Maintainability | 27-11-2020 | N | - | [link](/documentation/CodeAnalyzersRules/StyleCop/SA1413.md) |
52+
| SA1600 | Documentation | 04-12-2020 | Y | root | [link](/documentation/CodeAnalyzersRules/StyleCop/SA1600.md) |
53+
| SA1602 | Documentation | 04-12-2020 | Y | root | [link](/documentation/CodeAnalyzersRules/StyleCop/SA1602.md) |
54+
| SA1604 | Documentation | 04-12-2020 | Y | root | [link](/documentation/CodeAnalyzersRules/StyleCop/SA1604.md) |
55+
| SA1633 | Documentation | 04-12-2020 | Y | root | [link](/documentation/CodeAnalyzersRules/StyleCop/SA1633.md) |

‎documentation/CodeAnalyzersRules/StyleCop/SA1101.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,31 @@
33
## Meeting
44

55
### Date for meeting
6+
67
05-12-2020
78

89
### ATC Core members in meeting
10+
911
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1012
* [Per](https://github.com/orgs/atc-net/people/perkops)
1113

1214
### Rule summary
13-
| Key | Value |
15+
16+
| | Value |
1417
| ----------- |------------------------------------------------|
1518
| Title | SA1101PrefixLocalCallsWithThis |
1619
| CheckId | SA1101 |
1720
| Category | Readability Rules |
1821
| Link | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1101.md |
1922

2023
### What is the problem
24+
2125
[Issue #6](https://github.com/atc-net/atc-coding-rules/issues/6)
2226

2327
### Decision
28+
2429
We update the Root `.editorconfig` with a doc-link.
2530

2631
### Reason & arguments
27-
* This rule does not provide any value but only noise in the code.
32+
33+
* This rule does not provide any value but only noise in the code.

‎documentation/CodeAnalyzersRules/StyleCop/SA1200.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
1-
# Rule suppress suggestion - Decision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
05-12-2020
78

89
### ATC Core members in meeting
10+
911
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1012
* [Per](https://github.com/orgs/atc-net/people/perkops)
1113

1214
### Rule summary
13-
| Key | Value |
15+
16+
| | Value |
1417
| ----------- |------------------------------------------------|
1518
| Title | SA1200UsingDirectivesMustBePlacedCorrectly |
1619
| CheckId | SA1200 |
1720
| Category | Ordering Rules |
1821
| Link | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1200.md |
1922

2023
### What is the problem
24+
2125
[Issue #4](https://github.com/atc-net/atc-coding-rules/issues/4)
2226

2327
### Decision
28+
2429
We update the Root `.editorconfig` with a doc-link.
2530

2631
### Reason & arguments
27-
* This rule does not provide any value but only noise in the code.
32+
33+
* This rule does not provide any value but only noise in the code.

‎documentation/CodeAnalyzersRules/StyleCop/SA1413.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# Rule suppress suggestion - Decision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
27-11-2020
78

89
### ATC Core members in meeting
10+
911
* [Claus](https://github.com/orgs/atc-net/people/cjakobsen)
1012
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1113
* [Egil](https://github.com/orgs/atc-net/people/egil)
@@ -17,18 +19,22 @@
1719
* [Thomas](https://github.com/orgs/atc-net/people/TomMalow)
1820

1921
### Rule summary
20-
| Key | Value |
22+
23+
| | Value |
2124
| ----------- |------------------------------------------------|
2225
| Title | SA1413UseTrailingCommasInMultiLineInitializers |
2326
| CheckId | SA1413 |
2427
| Category | Maintainability Rules |
2528
| Link | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1413.md |
2629

2730
### What is the problem
31+
2832
[Issue #1](https://github.com/atc-net/atc-coding-rules/issues/1)
2933

3034
### Decision
35+
3136
Just follow the rule - see 'How to fix violations'
3237

3338
### Reason & arguments
39+
3440
* We like the argument for code review / `git blame`

‎documentation/CodeAnalyzersRules/StyleCop/SA1600.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
1-
# Rule suppress suggestion - Decision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
05-12-2020
78

89
### ATC Core members in meeting
10+
911
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1012
* [Per](https://github.com/orgs/atc-net/people/perkops)
1113

1214
### Rule summary
13-
| Key | Value |
15+
16+
| | Value |
1417
| ----------- |------------------------------------------------|
1518
| Title | SA1600ElementsMustBeDocumented |
1619
| CheckId | SA1600 |
1720
| Category | Documentation Rules |
1821
| Link | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1600.md |
1922

2023
### What is the problem
24+
2125
[Issue #5](https://github.com/atc-net/atc-coding-rules/issues/5)
2226

2327
### Decision
28+
2429
We update the Root `.editorconfig` with a doc-link.
2530

2631
### Reason & arguments
27-
* This rule does not provide any value but only noise in the code.
32+
33+
* This rule does not provide any value but only noise in the code.

‎documentation/CodeAnalyzersRules/StyleCop/SA1602.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
1-
# Rule suppress suggestion - Decision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
05-12-2020
78

89
### ATC Core members in meeting
10+
911
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1012
* [Per](https://github.com/orgs/atc-net/people/perkops)
1113

1214
### Rule summary
13-
| Key | Value |
15+
16+
| | Value |
1417
| ----------- |------------------------------------------------|
1518
| Title | SA1602EnumerationItemsMustBeDocumented |
1619
| CheckId | SA1602 |
1720
| Category | Documentation Rules |
1821
| Link | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1602.md |
1922

2023
### What is the problem
24+
2125
[Issue #7](https://github.com/atc-net/atc-coding-rules/issues/7)
2226

2327
### Decision
28+
2429
We update the Root `.editorconfig` with a doc-link.
2530

2631
### Reason & arguments
27-
* This rule does not provide any value but only noise in the code.
32+
33+
* This rule does not provide any value but only noise in the code.

‎documentation/CodeAnalyzersRules/StyleCop/SA1604.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
1-
# Rule suppress suggestion - Decision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
05-12-2020
78

89
### ATC Core members in meeting
10+
911
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1012
* [Per](https://github.com/orgs/atc-net/people/perkops)
1113

1214
### Rule summary
13-
| Key | Value |
15+
16+
| | Value |
1417
| ----------- |------------------------------------------------|
1518
| Title | SA1604ElementDocumentationMustHaveSummary |
1619
| CheckId | SA1604 |
1720
| Category | Documentation Rules |
1821
| Link | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1604.md |
1922

2023
### What is the problem
24+
2125
[Issue #8](https://github.com/atc-net/atc-coding-rules/issues/8)
2226

2327
### Decision
28+
2429
We update the Root `.editorconfig` with a doc-link.
2530

2631
### Reason & arguments
32+
2733
* This rule does not provide any value but only noise in the code.

‎documentation/CodeAnalyzersRules/StyleCop/SA1633.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
1-
# Rule suppress suggestion - Decision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
05-12-2020
78

89
### ATC Core members in meeting
10+
911
* [David](https://github.com/orgs/atc-net/people/davidkallesen)
1012
* [Per](https://github.com/orgs/atc-net/people/perkops)
1113

1214
### Rule summary
13-
| Key | Value |
15+
16+
| | Value |
1417
| ----------- |------------------------------------------------|
1518
| Title | SA1633FileMustHaveHeader |
1619
| CheckId | SA1633 |
1720
| Category | Documentation Rules |
1821
| Link | https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1633.md |
1922

2023
### What is the problem
24+
2125
[Issue #3](https://github.com/atc-net/atc-coding-rules/issues/3)
2226

2327
### Decision
28+
2429
We update the Root `.editorconfig` with a doc-link.
2530

2631
### Reason & arguments
27-
* This rule does not provide any value but only noise in the code.
2832

33+
* This rule does not provide any value but only noise in the code.

‎documentation/CodeAnalyzersRules/TEMPLATE-rule-suppress-decision.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
1-
# Rule suppress suggestion - Dicision
1+
# Rule suppression decision
22

33
## Meeting
44

55
### Date for meeting
6+
67
27-11-2020
78

89
### ATC Core members in meeting
10+
911
* [member a]
1012
* [member b]
1113
* [member c]
1214

1315
### Rule summary
14-
| Key | Value |
16+
17+
| | Value |
1518
| ----------- |------------------------------------------------|
1619
| Title | [SA1413UseTrailingCommasInMultiLineInitializers] |
1720
| CheckId | [SA1413] |
1821
| Category | [Maintainability Rules] |
1922
| Link | [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1413.md] |
2023

2124
### What is the problem
25+
2226
[describe the problem] - [link to issue or source]
2327

2428
### Decision
@@ -32,6 +36,7 @@
3236
* [we update the sub-located `.editorconfig` with a doc-link. Example: StyleCop/SAxxxx.md] (this file-copy)
3337

3438
### Reason & arguments
39+
3540
* [argument 1]
3641
* [argument 2]
3742
* [argument 3]

0 commit comments

Comments
 (0)
Please sign in to comment.