Skip to content
This repository was archived by the owner on Nov 8, 2018. It is now read-only.

Commit 8a31de5

Browse files
committed
Added initial LICENSE, README.md, and CONTRIBUTING.md
1 parent 2b9a4e0 commit 8a31de5

File tree

4 files changed

+38
-0
lines changed

4 files changed

+38
-0
lines changed

AsyncUsageAnalyzers.sln

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsyncUsageAnalyzers.Test",
99
EndProject
1010
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsyncUsageAnalyzers.Vsix", "AsyncUsageAnalyzers\AsyncUsageAnalyzers.Vsix\AsyncUsageAnalyzers.Vsix.csproj", "{8ABF883C-450A-4D0E-8D50-BF8A07C82C1B}"
1111
EndProject
12+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{84B978A9-3463-4915-B8D2-89AD4C919C68}"
13+
ProjectSection(SolutionItems) = preProject
14+
CONTRIBUTING.md = CONTRIBUTING.md
15+
LICENSE = LICENSE
16+
README.md = README.md
17+
EndProjectSection
18+
EndProject
1219
Global
1320
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1421
Debug|Any CPU = Debug|Any CPU

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
3+
1. To start working on a diagnostic, add a comment to the issue indicating you are working on implementing it.
4+
5+
2. Add a new issue for a code fix for the diagnostic. For example, I added DotNetAnalyzers/StyleCopAnalyzers#171 when I
6+
worked on DotNetAnalyzers/StyleCopAnalyzers#6. Even if no code fix is possible, the issue is a place for discussions
7+
regarding possible corrections. Code fixes may, but do not have to be implemented alongside the diagnostic.
8+
9+
3. If a diagnostic or code fix is submitted without tests, it might be rejected. However, it may be accepted provided
10+
all of the following are true:
11+
12+
1. The code is disabled by default, by passing `AnalyzerConstants.DisabledNoTests` for the `isEnabledByDefault`
13+
parameter when creating the `DiagnosticDescriptor`. It will be enabled by default only after tests are in place.
14+
2. A new issue was created for implementing tests for the item (e.g. DotNetAnalyzers/StyleCopAnalyzers#176).
15+
3. Evidence was given that the feature is currently operational, and the code appears to be a solid starting point
16+
for other contributors to continue the implementation effort.

LICENSE

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Copyright (c) Tunnel Vision Laboratories, LLC. All rights reserved.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
4+
these files except in compliance with the License. You may obtain a copy of the
5+
License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software distributed
10+
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
11+
CONDITIONS OF ANY KIND, either express or implied. See the License for the
12+
specific language governing permissions and limitations under the License.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Async Usage Analyzers for the .NET Compiler Platform
2+
3+
This repository contains analyzers for best practices related to asynchronous programming. Where possible, code fixes are also provided to simplify the process of correcting violations.

0 commit comments

Comments
 (0)