Skip to content
This repository has been archived by the owner on Apr 8, 2019. It is now read-only.

Update README.md #32

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,26 @@

[![codecov.io](http://codecov.io/github/DotNetAnalyzers/PublicApiAnalyzer/coverage.svg?branch=master)](http://codecov.io/github/DotNetAnalyzers/PublicApiAnalyzer?branch=master)

The purpose of this analyzer is to write the public API to two text files, PublicAPI.Unshipped.txt and PublicAPI.Shipped.txt. Add the files to source control to keep track of how the API evolves.
JohanLarsson marked this conversation as resolved.
Show resolved Hide resolved

## Using Public API Analyzer

The preferable way to use this package is to add the NuGet package [DotNetAnalyzers.PublicApiAnalyzer](http://www.nuget.org/packages/DotNetAnalyzers.PublicApiAnalyzer/)
to the project where you want to enforce rules.

The severity of individual rules may be configured using [rule set files](https://msdn.microsoft.com/en-us/library/dd264996.aspx)
in Visual Studio 2015.
in Visual Studio.

### In development

Use the code fix to update PublicAPI.Unshipped.txt.
JohanLarsson marked this conversation as resolved.
Show resolved Hide resolved

### When releasing

1. Delete the contents of PublicAPI.Unshipped.txt and PublicAPI.Shipped.txt.
JohanLarsson marked this conversation as resolved.
Show resolved Hide resolved
2. Use the code fix to write the publid API to PublicAPI.Unshipped.txt.
JohanLarsson marked this conversation as resolved.
Show resolved Hide resolved
3. Cut the contents of PublicAPI.Unshipped.txt and paste it to PublicAPI.Shipped.txt.
JohanLarsson marked this conversation as resolved.
Show resolved Hide resolved
The result should be empty PublicAPI.Unshipped.txt and complete PublicAPI.Unshipped.txt.
JohanLarsson marked this conversation as resolved.
Show resolved Hide resolved

## Team Considerations

Expand Down