Skip to content

docs(docs): decompose and relocate detailed contributing guide#156

Merged
WilliamBerryiii merged 6 commits intomainfrom
docs/contributing-restructure-154
Feb 10, 2026
Merged

docs(docs): decompose and relocate detailed contributing guide#156
WilliamBerryiii merged 6 commits intomainfrom
docs/contributing-restructure-154

Conversation

@WilliamBerryiii
Copy link
Member

Description

Decomposes the 812-line .github/CONTRIBUTING.md into a modular structure under docs/contributing/, creating three new sub-guides and expanding the hub document. Deletes the original monolithic file, updates all internal cross-references, and aligns the root CONTRIBUTING.md as a concise entry point.

Closes #154

Changes

  • Extract prerequisites, contribution workflow, and pull request process into standalone sub-guides under docs/contributing/
  • Expand docs/contributing/README.md from a 35-line index into a 254-line hub with summary sections, quick reference matrix, and guide tables
  • Rebuild root CONTRIBUTING.md as a concise entry point with guide table linking to sub-documents
  • Delete .github/CONTRIBUTING.md (812 lines) — all content preserved in new locations
  • Update back-links in 4 existing sub-guides (cost-considerations, deployment-validation, infrastructure-style, security-review) from .github/CONTRIBUTING.md to README.md
  • Fix broken anchor in infrastructure-style.md caused by emoji variant selector mismatch
  • Convert bold-prefix list items to table format in contribution-workflow.md
  • Promote bold pseudo-headings to proper H3/H4 in prerequisites.md, README.md, pull-request-process.md
  • Remove hve-core references from README.md and setup-dev.sh that no longer apply
  • Reformat option tables in scripts/README.md for consistent column separator style

Files Changed (13)

File Action Summary
.github/CONTRIBUTING.md Deleted Original 812-line monolithic contributing guide
CONTRIBUTING.md Modified Rebuilt as concise ~77-line entry point with guide table
README.md Modified Removed hve-core tool references, replaced uv with pyenv
docs/contributing/README.md Modified Expanded from ~35-line index to ~254-line hub document
docs/contributing/contribution-workflow.md Added 206 lines — legal notice, bug reports, enhancement suggestions, PR workflow
docs/contributing/cost-considerations.md Modified Updated back-links to README.md
docs/contributing/deployment-validation.md Modified Updated back-links to README.md
docs/contributing/infrastructure-style.md Modified Updated back-links, fixed broken anchor fragment
docs/contributing/prerequisites.md Added 159 lines — required tools table, Azure access, NGC setup, cost awareness
docs/contributing/pull-request-process.md Added 134 lines — PR workflow steps, reviewer assignment, approval criteria
docs/contributing/security-review.md Modified Updated back-links to README.md
scripts/README.md Modified Reformatted option tables to consistent `
setup-dev.sh Modified Removed 10-line hve-core check section

Type of Change

  • 🐛 Bug fix (non-breaking change fixing an issue)
  • ✨ New feature (non-breaking change adding functionality)
  • 💥 Breaking change (fix or feature causing existing functionality to change)
  • 📚 Documentation update
  • 🏗️ Infrastructure change (Terraform/IaC)
  • ♻️ Refactoring (no functional changes)

Component(s) Affected

  • deploy/000-prerequisites - Azure subscription setup
  • deploy/001-iac - Terraform infrastructure
  • deploy/002-setup - OSMO control plane / Helm
  • deploy/004-workflow - Training workflows
  • src/training - Python training scripts
  • docs/ - Documentation

Testing Performed

  • Terraform plan reviewed (no unexpected changes)
  • Terraform apply tested in dev environment
  • Training scripts tested locally with Isaac Sim
  • OSMO workflow submitted successfully
  • Smoke tests passed (smoke_test_azure.py)

Static validation performed:

  • npm run lint:md — no warnings
  • npm run spell-check — clean
  • All internal cross-reference links verified

Checklist

- 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
Copilot AI review requested due to automatic review settings February 9, 2026 17:58
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md as 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
@github-actions
Copy link

github-actions bot commented Feb 9, 2026

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@WilliamBerryiii WilliamBerryiii merged commit 3783400 into main Feb 10, 2026
8 checks passed
@WilliamBerryiii WilliamBerryiii deleted the docs/contributing-restructure-154 branch February 10, 2026 01:19
This was referenced Feb 10, 2026
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.

docs(contributing): decompose and relocate detailed contributing guide

3 participants