From 4be5d8a10555a2c9a54b985255b2523c535f5f68 Mon Sep 17 00:00:00 2001 From: Johan Larsson Date: Mon, 7 Jan 2019 18:09:26 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b3c421d..01561c3 100644 --- a/README.md +++ b/README.md @@ -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. + ## 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. + +### When releasing + +1. Delete the contents of PublicAPI.Unshipped.txt and PublicAPI.Shipped.txt. +2. Use the code fix to write the publid API to PublicAPI.Unshipped.txt. +3. Cut the contents of PublicAPI.Unshipped.txt and paste it to PublicAPI.Shipped.txt. +The result should be empty PublicAPI.Unshipped.txt and complete PublicAPI.Unshipped.txt. ## Team Considerations From ad6e8052dc2372eaea526079d94719ce42351830 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Tue, 8 Jan 2019 23:48:36 +0100 Subject: [PATCH 2/2] Apply suggestions from code review PR feedback. Co-Authored-By: JohanLarsson --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 01561c3..27c2b43 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![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. +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. ## Using Public API Analyzer @@ -20,14 +20,15 @@ in Visual Studio. ### In development -Use the code fix to update PublicAPI.Unshipped.txt. +Use the code fix to update **PublicAPI.Unshipped.txt**. ### When releasing -1. Delete the contents of PublicAPI.Unshipped.txt and PublicAPI.Shipped.txt. -2. Use the code fix to write the publid API to PublicAPI.Unshipped.txt. -3. Cut the contents of PublicAPI.Unshipped.txt and paste it to PublicAPI.Shipped.txt. -The result should be empty PublicAPI.Unshipped.txt and complete PublicAPI.Unshipped.txt. +1. Delete the contents of **PublicAPI.Unshipped.txt** and **PublicAPI.Shipped.txt**. +2. Use the code fix to write the public API to **PublicAPI.Unshipped.txt**. +3. Cut the contents of **PublicAPI.Unshipped.txt** and paste it to **PublicAPI.Shipped.txt**. + +The result should be empty **PublicAPI.Unshipped.txt** and complete **PublicAPI.Unshipped.txt**. ## Team Considerations