Skip to content

doc: rewrite contributing guide from scratch#947

Merged
glennawatson merged 4 commits intomainfrom
docs/rewrite-contributing-guide
Apr 3, 2026
Merged

doc: rewrite contributing guide from scratch#947
glennawatson merged 4 commits intomainfrom
docs/rewrite-contributing-guide

Conversation

@glennawatson
Copy link
Copy Markdown
Contributor

Summary

  • Replaced 50+ verbose, outdated contributing files (1,675 lines deleted) with 7 focused pages (381 lines)
  • Removed dead sections: Community, Content Style Guide, Design, Developer Experience, Marketing, Compiling ReactiveUI, Features and Patches
  • Updated commit conventions to match actual prefixes used by GitReleaseNoteGenerator (break, feat, fix, refactor, perf, chore, test, doc, style, dep, ci)
  • Added fork workflow guidance (gh CLI, web UI, github.dev/Codespaces) with sync instructions
  • Added AI-assisted development page covering agent.md setup, when to use AI tools, and disclosure expectations
  • Added CI & shared tooling page explaining actions-common, analysers, Nerdbank.GitVersioning, and Renovate
  • Condensed 15+ maintainer files into a single page
  • Replaced StackOverflow references with GitHub Discussions (per-repo or main repo for general questions)
  • Added strong "discuss first" messaging for non-trivial contributions

New structure

Page Content
Getting Started Quick start, repo table, discussions, CoC, license
Building & Testing Clone, build, test, analysers, multi-targeting, approval tests
Pull Requests Fork workflow, discuss-first policy, PR lifecycle
Code Style Kept as-is
Commit Conventions Rewritten with actual prefixes from release note generator
AI-Assisted Development agent.md, when AI helps, when to be careful, disclosure
CI & Shared Tooling actions-common, shared analysers, versioning, Renovate
Maintainers Merging, triage, releases, versioning, team management

Test plan

  • Verify DocFX builds the site without broken links
  • Check toc.yml navigation renders correctly
  • Review each new page for accuracy

Replace 50+ verbose, outdated files with 7 focused pages. Keep the code
style guide, rewrite everything else for new contributors.

New structure:
- Getting Started — quick start, repo table, GitHub Discussions
- Building & Testing — clone, build, test, analysers, multi-targeting
- Pull Requests — fork workflow (gh CLI, web UI, Codespaces), discuss-first policy
- Code Style — kept as-is
- Commit Conventions — updated to match GitReleaseNoteGenerator prefixes
- AI-Assisted Development — agent.md setup, when to use AI, disclosure
- CI & Shared Tooling — actions-common, analysers, versioning, Renovate
- Maintainers — condensed from 15+ files to one page

Removed: Community, Content Style Guide, Design, Developer Experience,
Marketing, Compiling ReactiveUI, Features and Patches sections.
Document the GitHub Actions release pipeline (build/sign/publish/release)
with version bumping workflow and direct push instructions for authorised
maintainers. Notes this is the pattern being rolled out across the org
with ReactiveUI as the reference implementation.
Explain how the shared Renovate preset in reactiveui/.github works,
default settings (combine patch+minor, separate majors, 3-day release
age), package grouping rules, and how to onboard new repos.
Cover CodeQL setup (shared reusable workflow, security-extended queries,
C#/Actions/JS scanning), Dependabot security alerts, secret scanning
with push protection, and branch rulesets. Includes onboarding example
for new repos.
@glennawatson glennawatson enabled auto-merge (squash) April 3, 2026 02:04
@glennawatson glennawatson merged commit 14934f6 into main Apr 3, 2026
4 checks passed
@glennawatson glennawatson deleted the docs/rewrite-contributing-guide branch April 3, 2026 02:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants