docs(docs): decompose and relocate detailed contributing guide#156
Merged
WilliamBerryiii merged 6 commits intomainfrom Feb 10, 2026
Merged
docs(docs): decompose and relocate detailed contributing guide#156WilliamBerryiii merged 6 commits intomainfrom
WilliamBerryiii merged 6 commits intomainfrom
Conversation
- move 812-line .github/CONTRIBUTING.md into docs/contributing/ sub-guides - add prerequisites.md, contribution-workflow.md, pull-request-process.md - merge hub guide into docs/contributing/README.md with quick-reference matrix - rebuild root CONTRIBUTING.md as concise entry point with guide table - update all cross-references and back-links across sub-guides Closes #154 📝 - Generated by Copilot
- convert bold-prefix list to table in contribution-workflow.md - convert bold pseudo-headings to H3/H4 in prerequisites.md, README.md, pull-request-process.md - add emoji prefixes to Contributing Guides and Infrastructure as Code Style headings - replace em dash with colon in root CONTRIBUTING.md 📝 - Generated by Copilot
There was a problem hiding this comment.
Pull request overview
This PR restructures the contributing documentation by replacing the monolithic .github/CONTRIBUTING.md with a modular set of guides under docs/contributing/, and updates cross-links so the root CONTRIBUTING.md becomes the primary entry point for GitHub’s contributing discovery.
Changes:
- Split contributing content into a hub document (
docs/contributing/README.md) plus three new focused sub-guides (prerequisites, contribution workflow, PR process). - Update existing contributing sub-guides to link back to the new hub location instead of the deleted
.github/CONTRIBUTING.md. - Rebuild root
CONTRIBUTING.mdas a concise entry point and delete.github/CONTRIBUTING.md.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
.github/CONTRIBUTING.md |
Removes the legacy monolithic contributing guide after content is relocated. |
CONTRIBUTING.md |
New concise entry point linking to the modular guides (some doc issues noted). |
docs/contributing/README.md |
Expanded hub guide that centralizes links, prerequisites, validation, and policies. |
docs/contributing/prerequisites.md |
New prerequisites + validation commands guide. |
docs/contributing/contribution-workflow.md |
New contribution workflow guide (bugs/enhancements/docs). |
docs/contributing/pull-request-process.md |
New PR process guide (reviewers, cycles, approval criteria, updates). |
docs/contributing/cost-considerations.md |
Backlink updates to point to the new hub. |
docs/contributing/deployment-validation.md |
Backlink updates to point to the new hub. |
docs/contributing/infrastructure-style.md |
Backlink updates and fragment cleanup for the hub section link. |
docs/contributing/security-review.md |
Backlink updates to point to the new hub. |
README.md |
Updated contributor/dev tool references (not included in provided diff excerpt). |
scripts/README.md |
Table formatting consistency updates (not included in provided diff excerpt). |
setup-dev.sh |
Removes outdated checks/refs (not included in provided diff excerpt). |
- replace invalid ms.topic value with how-to - remove emoji and star-repo callout from contributor intro - decouple branch naming from conventional commits reference - remove hard-coded date from cost estimate note - remove hedging qualifier from lint:links instruction 📝 - Generated by Copilot
…tructure-154 # Conflicts: # .github/CONTRIBUTING.md # CONTRIBUTING.md # docs/contributing/README.md
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
agreaves-ms
approved these changes
Feb 10, 2026
…tructure-154 # Conflicts: # CONTRIBUTING.md
This was referenced Feb 10, 2026
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.
Description
Decomposes the 812-line
.github/CONTRIBUTING.mdinto a modular structure underdocs/contributing/, creating three new sub-guides and expanding the hub document. Deletes the original monolithic file, updates all internal cross-references, and aligns the rootCONTRIBUTING.mdas a concise entry point.Closes #154
Changes
docs/contributing/docs/contributing/README.mdfrom a 35-line index into a 254-line hub with summary sections, quick reference matrix, and guide tablesCONTRIBUTING.mdas a concise entry point with guide table linking to sub-documents.github/CONTRIBUTING.md(812 lines) — all content preserved in new locationscost-considerations,deployment-validation,infrastructure-style,security-review) from.github/CONTRIBUTING.mdtoREADME.mdinfrastructure-style.mdcaused by emoji variant selector mismatchcontribution-workflow.mdprerequisites.md,README.md,pull-request-process.mdREADME.mdandsetup-dev.shthat no longer applyscripts/README.mdfor consistent column separator styleFiles Changed (13)
.github/CONTRIBUTING.mdCONTRIBUTING.mdREADME.mduvwithpyenvdocs/contributing/README.mddocs/contributing/contribution-workflow.mddocs/contributing/cost-considerations.mdREADME.mddocs/contributing/deployment-validation.mdREADME.mddocs/contributing/infrastructure-style.mddocs/contributing/prerequisites.mddocs/contributing/pull-request-process.mddocs/contributing/security-review.mdREADME.mdscripts/README.mdsetup-dev.shType of Change
Component(s) Affected
deploy/000-prerequisites- Azure subscription setupdeploy/001-iac- Terraform infrastructuredeploy/002-setup- OSMO control plane / Helmdeploy/004-workflow- Training workflowssrc/training- Python training scriptsdocs/- DocumentationTesting Performed
planreviewed (no unexpected changes)applytested in dev environmentsmoke_test_azure.py)Static validation performed:
npm run lint:md— no warningsnpm run spell-check— cleanChecklist