docs: Contributing guide — entry point and CONTRIBUTING.md#12174
Merged
brooke-hamilton merged 2 commits intoJun 23, 2026
Merged
Conversation
Consolidate the contributor entry points: fold the 'ways to contribute' content from docs/contributing/how-to.md into CONTRIBUTING.md and delete how-to.md, leaving a single authoritative entry list. CONTRIBUTING.md is trimmed to process + DCO + a single link to the contributor docs index (docs/contributing/README.md). The duplicate deep-link table of contents is replaced by the docs-index pointer. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
brooke-hamilton
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates contributor “entry point” navigation by removing the standalone docs/contributing/how-to.md page and replacing the long, duplicate link list in CONTRIBUTING.md with a short “Ways to contribute” section that points readers to a single docs landing page.
Changes:
- Deleted
docs/contributing/how-to.mdafter folding its “ways to contribute” content intoCONTRIBUTING.md. - Replaced
CONTRIBUTING.md’s deep-link table-of-contents with a concise contribution overview plus a single link todocs/contributing/README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Replaces the previous contributor doc link list with a “Ways to contribute” section and a single “docs index” link. |
docs/contributing/how-to.md |
Removes the redundant “How to contribute” entry-point page. |
Address PR review: CONTRIBUTING.md linked docs/contributing/README.md and described it as the full docs index, but that page currently holds only Agent Ex conventions (the aggregated index lands in PR 8). Point both references at the ./docs/contributing/ folder (which contains the guide subdirectories today and follows the existing directory-link pattern) and drop the completeness language. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
10 tasks
10 tasks
brooke-hamilton
changed the title
willdavsmith
approved these changes
Jun 22, 2026
brooke-hamilton
merged commit a949682
into
brooke-hamilton/agentex-phase3
5 checks passed
brooke-hamilton
added a commit
that referenced
this pull request
Jul 1, 2026
## Summary This is **PR 1 (Entry-point cleanup)** of the [Agent Ex — Phase 3 (Contributing docs) plan](https://github.com/radius-project/radius/blob/brooke-hamilton/agentex-phase3/specs/002-agent-ex/agent-ex-phase-3-plan.md) — see the **PR 1 — Entry-point cleanup** task under §6 of that plan. It consolidates the contributor entry points so there is exactly **one authoritative entry list** instead of two overlapping ones. - Folds the "ways to contribute" content from `docs/contributing/how-to.md` into `CONTRIBUTING.md` and **deletes `how-to.md`**. - Replaces the duplicate deep-link table of contents in `CONTRIBUTING.md` with a single link to the contributor docs index (`docs/contributing/README.md`), per the plan's target structure (process + DCO + one link to the docs index). - Fixes the one inbound link to `how-to.md` (in `CONTRIBUTING.md`). A repo-wide grep confirms no other non-planning files linked to it. The docs index itself is intentionally **not** built here — that is PR 8. ## Merge target⚠️ This PR targets the `brooke-hamilton/agentex-phase3` **plan branch, not `main`**. It is one of seven stacked Batch A PRs; approving and merging it lands the change on the plan branch only — **it does not merge anything to `main`**. The whole phase rolls up to `main` in a single follow-up PR after all Batch A PRs (and the PR 8/9 index work) land. ## Files changed - `CONTRIBUTING.md` — edited (absorbs the contribution list, drops the duplicate table of contents). - `docs/contributing/how-to.md` — deleted (its content now lives in `CONTRIBUTING.md`). No other docs are affected, and the planning documents under `specs/002-agent-ex/` are intentionally left as-is. --------- Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
nithyatsu
pushed a commit
to nithyatsu/radius
that referenced
this pull request
Jul 2, 2026
…dex layer (radius-project#12290) ## Origin Agent Ex is the effort to turn `docs/contributing/` into a single shared knowledge base that humans and every supported AI agent (Copilot in VS Code, Copilot CLI, Copilot Cloud Agent, Claude Code) read through one entry point. The [Agent Ex plan](specs/002-agent-ex/agent-ex-plan.md) splits the work into phases; this PR delivers [Phase 3 — Contributing docs](specs/002-agent-ex/agent-ex-phase-3-plan.md), whose north star is that every "how do I do X?" question has exactly one current, correctly-formatted primary doc, reachable from one index. ## Scope - **Consolidate + reformat.** The seven topic clusters (entry point, prerequisites, building + CLI, running/debugging locally, testing, schema changes, process/reference) are each collapsed into one authoritative doc in the standard **Purpose → Prerequisites → Steps → Verification → Troubleshooting** format; deprecated/duplicate docs (`how-to.md`, `running-controlplane-locally.md`) are deleted and inbound links repointed. - **Documentation index + capability index** added to `docs/contributing/README.md`, replacing the older competing link lists. - **Four new primary docs** for capabilities 1.5–1.8 (GitHub workflows, Dockerfiles, Bicep files, shell scripts & Makefiles) that the `.github/instructions/*` files complement. - **Code↔doc path map** seeded in `contributing-agent-assets.md` for the docs-drift review step. ## History This branch was built up from seven topic PRs, each consolidating and reformatting one cluster, then merged here: - radius-project#12174 — entry point and CONTRIBUTING.md - radius-project#12175 — prerequisites and dev environment - radius-project#12176 — running and debugging locally - radius-project#12177 — testing - radius-project#12178 — process and reference docs - radius-project#12179 — schema changes - radius-project#12180 — building and the rad CLI This PR adds the index layer on top (documentation index, capability index, the four new 1.5–1.8 docs, and the path map). ## Verification `cspell` and `markdownlint` clean on changed files; all relative links and anchors resolve. --------- Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sk593
pushed a commit
that referenced
this pull request
Jul 6, 2026
…dex layer (#12290) ## Origin Agent Ex is the effort to turn `docs/contributing/` into a single shared knowledge base that humans and every supported AI agent (Copilot in VS Code, Copilot CLI, Copilot Cloud Agent, Claude Code) read through one entry point. The [Agent Ex plan](specs/002-agent-ex/agent-ex-plan.md) splits the work into phases; this PR delivers [Phase 3 — Contributing docs](specs/002-agent-ex/agent-ex-phase-3-plan.md), whose north star is that every "how do I do X?" question has exactly one current, correctly-formatted primary doc, reachable from one index. ## Scope - **Consolidate + reformat.** The seven topic clusters (entry point, prerequisites, building + CLI, running/debugging locally, testing, schema changes, process/reference) are each collapsed into one authoritative doc in the standard **Purpose → Prerequisites → Steps → Verification → Troubleshooting** format; deprecated/duplicate docs (`how-to.md`, `running-controlplane-locally.md`) are deleted and inbound links repointed. - **Documentation index + capability index** added to `docs/contributing/README.md`, replacing the older competing link lists. - **Four new primary docs** for capabilities 1.5–1.8 (GitHub workflows, Dockerfiles, Bicep files, shell scripts & Makefiles) that the `.github/instructions/*` files complement. - **Code↔doc path map** seeded in `contributing-agent-assets.md` for the docs-drift review step. ## History This branch was built up from seven topic PRs, each consolidating and reformatting one cluster, then merged here: - #12174 — entry point and CONTRIBUTING.md - #12175 — prerequisites and dev environment - #12176 — running and debugging locally - #12177 — testing - #12178 — process and reference docs - #12179 — schema changes - #12180 — building and the rad CLI This PR adds the index layer on top (documentation index, capability index, the four new 1.5–1.8 docs, and the path map). ## Verification `cspell` and `markdownlint` clean on changed files; all relative links and anchors resolve. --------- Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: sk593 <shruthikumar@microsoft.com>
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
This is PR 1 (Entry-point cleanup) of the Agent Ex — Phase 3 (Contributing docs) plan — see the PR 1 — Entry-point cleanup task under §6 of that plan. It consolidates the contributor entry points so there is exactly one authoritative entry list instead of two overlapping ones.
docs/contributing/how-to.mdintoCONTRIBUTING.mdand deleteshow-to.md.CONTRIBUTING.mdwith a single link to the contributor docs index (docs/contributing/README.md), per the plan's target structure (process + DCO + one link to the docs index).how-to.md(inCONTRIBUTING.md). A repo-wide grep confirms no other non-planning files linked to it.The docs index itself is intentionally not built here — that is PR 8.
Merge target
brooke-hamilton/agentex-phase3plan branch, notmain. It is one of seven stacked Batch A PRs; approving and merging it lands the change on the plan branch only — it does not merge anything tomain. The whole phase rolls up tomainin a single follow-up PR after all Batch A PRs (and the PR 8/9 index work) land.Files changed
CONTRIBUTING.md— edited (absorbs the contribution list, drops the duplicate table of contents).docs/contributing/how-to.md— deleted (its content now lives inCONTRIBUTING.md).No other docs are affected, and the planning documents under
specs/002-agent-ex/are intentionally left as-is.