Open
Conversation
Add standard Microsoft community health files required by the open source release checklist. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
rgregg-msft
force-pushed
the
add-community-health-files
branch
from
d6348b2 to
dc7672c
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds required community health files for an open-source release, and also modernizes the repo’s packaging/CI setup to build, test (with coverage), and produce a .NET tool NuGet package.
Changes:
- Add
SECURITY.mdandCODE_OF_CONDUCT.mdusing Microsoft standard templates. - Update CI to run on Ubuntu + Windows, collect/upload code coverage on Ubuntu, and pack/upload the tool package.
- Migrate console packaging from a
.nuspecto SDK-styledotnet packconfiguration (incl. MinVer), and update various docs/tests to consistently refer to “API Doctor”.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/markdown-requirements.md | Replace legacy “Markdown scanner” wording with “API Doctor”. |
| docs/account-configuration.md | Rename headings/text to “API Doctor”. |
| SECURITY.md | Add standard Microsoft security reporting guidance. |
| README.md | Switch build badge from AppVeyor to GitHub Actions. |
| LICENSE | Add MIT license file. |
| CONTRIBUTING.md | Update contribution doc wording to “API Doctor”. |
| CODE_OF_CONDUCT.md | Add Microsoft Open Source Code of Conduct. |
| ApiDoctor.Validation.UnitTests/YamlParserTests.cs | Update test strings to “API Doctor”. |
| ApiDoctor.Validation.UnitTests/ApiDoctor.Validation.UnitTests.csproj | Add coverlet.collector for coverage. |
| ApiDoctor.DocumentationGeneration.UnitTests/ApiDoctor.DocumentationGeneration.UnitTests.csproj | Add coverlet.collector for coverage. |
| ApiDoctor.Console.UnitTests/ApiDoctor.Console.UnitTests.csproj | Add coverlet.collector for coverage. |
| ApiDoctor.Console/ApiDoctor.ConsoleApp.nuspec | Remove legacy .nuspec packaging. |
| ApiDoctor.Console/ApiDoctor.ConsoleApp.csproj | Configure project for dotnet tool packing and add MinVer + package metadata. |
| .github/workflows/dotnet.yml | Add OS matrix, NuGet caching, coverage collection/upload, and pack/upload steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SECURITY.mdusing the standard Microsoft template, directing reporters to https://aka.ms/SECURITY.mdCODE_OF_CONDUCT.mdadopting the Microsoft Open Source Code of ConductThese files are required by the Microsoft open source release checklist and complete the community health files needed before publishing to NuGet (tracked in #108).
Test plan
🤖 Generated with Claude Code