Added initial LICENSE, README.md, and CONTRIBUTING.md

tmaczynski · May 3, 2015 · 8a31de5 · 8a31de5
1 parent 2b9a4e0
commit 8a31de5
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/AsyncUsageAnalyzers.sln b/AsyncUsageAnalyzers.sln
@@ -9,6 +9,13 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsyncUsageAnalyzers.Test",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsyncUsageAnalyzers.Vsix", "AsyncUsageAnalyzers\AsyncUsageAnalyzers.Vsix\AsyncUsageAnalyzers.Vsix.csproj", "{8ABF883C-450A-4D0E-8D50-BF8A07C82C1B}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{84B978A9-3463-4915-B8D2-89AD4C919C68}"
+	ProjectSection(SolutionItems) = preProject
+		CONTRIBUTING.md = CONTRIBUTING.md
+		LICENSE = LICENSE
+		README.md = README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+# Contributing
+
+1. To start working on a diagnostic, add a comment to the issue indicating you are working on implementing it.
+
+2. Add a new issue for a code fix for the diagnostic. For example, I added DotNetAnalyzers/StyleCopAnalyzers#171 when I
+   worked on DotNetAnalyzers/StyleCopAnalyzers#6. Even if no code fix is possible, the issue is a place for discussions
+   regarding possible corrections. Code fixes may, but do not have to be implemented alongside the diagnostic.
+
+3. If a diagnostic or code fix is submitted without tests, it might be rejected. However, it may be accepted provided
+   all of the following are true:
+
+   1. The code is disabled by default, by passing `AnalyzerConstants.DisabledNoTests` for the `isEnabledByDefault`
+      parameter when creating the `DiagnosticDescriptor`. It will be enabled by default only after tests are in place.
+   2. A new issue was created for implementing tests for the item (e.g. DotNetAnalyzers/StyleCopAnalyzers#176).
+   3. Evidence was given that the feature is currently operational, and the code appears to be a solid starting point
+      for other contributors to continue the implementation effort.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,12 @@
+Copyright (c) Tunnel Vision Laboratories, LLC. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+these files except in compliance with the License. You may obtain a copy of the
+License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Async Usage Analyzers for the .NET Compiler Platform
+
+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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Async Usage Analyzers for the .NET Compiler Platform

		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.