Skip to content

Commit 1c44325

Browse files
committed
Implement CR feedback
1 parent e1ffef5 commit 1c44325

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Contributing
22

3+
If you want to contribute code you can get started by looking for issues marked as
4+
[up for grabs](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/labels/up%20for%20grabs).
5+
We also have the [easy](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/labels/easy) tag
6+
for issues suitable if you are unfamiliar with roslyn.
7+
8+
Also see the [contributing guide](CONTRIBUTING.md).
9+
10+
You can also help by filing issues, participating in discussions and doing code review.
11+
12+
## Implementing a diagnostic
13+
314
1. To start working on a diagnostic, add a comment to the issue indicating you are working on implementing it.
415

516
2. Add a new issue for a code fix for the diagnostic. For example, I added #171 when I worked on #6. Even if no code fix
@@ -14,3 +25,9 @@
1425
2. A new issue was created for implementing tests for the item (e.g. #176).
1526
3. Evidence was given that the feature is currently operational, and the code appears to be a solid starting point
1627
for other contributors to continue the implementation effort.
28+
29+
## Building
30+
31+
Visual Studio 2015 RC is required for building this repository.
32+
The Visual Studio 2015 RC SDK is required for building the vsix extension project and for
33+
debugging in an experimental visual studio hive.

README.md

+8-13
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,22 @@ This repository contains an implementation of the StyleCop rules using the .NET
1010

1111
The preferable way to use the analyzers is to add the nuget package [StyleCop.Analyzers](http://www.nuget.org/packages/StyleCop.Analyzers/)
1212
to the project where you want to enforce StyleCop rules.
13-
You can also build a vsix extension from source and install it into visual studio to use it in all
14-
C# projects opened in visual studio.
1513

1614
Currently the only way to configure the rules is to change the severity for them in a ruleset file.
1715

18-
## Building
16+
## Installation
1917

20-
Visual Studio 2015 RC is required for building this repository.
21-
The Visual Studio 2015 RC SDK is required for building the vsix extension project and for
22-
debugging in an experimental visual studio hive.
18+
StyleCopAnalyzers can be installed using the NuGet Package Manager in Visual Studio 2015 RC.
2319

24-
## Contributing
20+
![Install via nuget](https://cloud.githubusercontent.com/assets/1408396/8233513/491f301a-159c-11e5-8b7a-1e16a0695da6.png)
21+
22+
## Team Considerations
2523

26-
If you want to contribute code you can get started by looking for issues marked as
27-
[up for grabs](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/labels/up%20for%20grabs).
28-
We also have the [easy](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/labels/easy) tag
29-
for issues suitable if you are unfamiliar with roslyn.
24+
If you use older versions of Visual Studio in addition to Visual Studio 2015, you may still install these analyzers. They will be automatically disabled when you open the project back up in Visual Studio 2013 or earlier.
3025

31-
Also see the [contributing guide](CONTRIBUTING.md).
26+
## Contributing
3227

33-
You can also help by filing issues, participating in discussions and doing code review.
28+
See [Contributing](CONTRIBUTING.md)
3429

3530
## Current status
3631

0 commit comments

Comments
 (0)