Skip to content

docs: add open source community health files and enable XML docs#936

Merged
akunzai merged 4 commits into
mainfrom
feat/opensource-improvements
Jun 9, 2026
Merged

docs: add open source community health files and enable XML docs#936
akunzai merged 4 commits into
mainfrom
feat/opensource-improvements

Conversation

@akunzai

@akunzai akunzai commented Jun 9, 2026

Copy link
Copy Markdown
Owner

Changes

  • Add .github/SECURITY.md with private vulnerability reporting policy (GitHub Advisory)
  • Add CONTRIBUTING.md with development setup, test commands, PR workflow, and label guide
  • Add .github/PULL_REQUEST_TEMPLATE.md with type-of-change checklist
  • Add .github/CODEOWNERS for auto-review assignment
  • Enable GenerateDocumentationFile in src/Directory.Build.props for NuGet XML API docs
  • Expand PackageTags and add PackageReleaseNotes in src/Directory.Build.props

Motivation

Based on open source best practices audit. Key gaps addressed:

Before After
No security disclosure channel SECURITY.md → GitHub Private Vulnerability Reporting
No contributor guide CONTRIBUTING.md with full setup + PR workflow
No PR template Checklist enforcing label + build + test
No CODEOWNERS Auto-assigns @akunzai as reviewer
No XML API docs in NuGet package GenerateDocumentationFile=true (CS1591 suppressed for incremental adoption)

Verification

  • dotnet build -c Release → ✅ 0 warnings, 0 errors
  • markdownlint-cli2 → ✅ 0 errors
  • XML docs confirmed generated for all src/ TFMs

@akunzai akunzai added the documentation Documentation changes label Jun 9, 2026
@github-actions github-actions Bot added the feature New features label Jun 9, 2026
@akunzai akunzai merged commit 7206dc2 into main Jun 9, 2026
9 checks passed
@akunzai akunzai deleted the feat/opensource-improvements branch June 9, 2026 13:19
@codecov

codecov Bot commented Jun 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.58%. Comparing base (87f81f0) to head (334ba8d).
⚠️ Report is 28 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #936      +/-   ##
==========================================
+ Coverage   71.08%   72.58%   +1.49%     
==========================================
  Files          42       25      -17     
  Lines        1048      558     -490     
  Branches      136       75      -61     
==========================================
- Hits          745      405     -340     
+ Misses        240      119     -121     
+ Partials       63       34      -29     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes feature New features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant