S-1: Registry Governance Documentation

Open Beginner friendly
#7,849 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
go
Domain
documentation

Research direction

Read docs/design/azd-tool/plan.md and todos.md first, then review pkg/extensions/registry.go for the existing registry model. Create docs/design/azd-tool/registry-governance.md covering ownership, approval, SLA, required contribution fields, and PR-based ingestion with CI validation. Done means the document includes the template and acceptance criteria, then receives team review and approval.

Written by the indexing model from the issue text.

Description

area/core-cli epic

Problem / User Value

Partner teams at Microsoft need a clear, documented process for submitting their tools to the azd registry. Without a governance model, the registry becomes ungoverned — either no one knows how to contribute, or tools are added without quality review, leading to stale or broken entries.

Definition of Done

Governance document published at docs/design/azd-tool/registry-governance.md with ownership, approval process, SLA, contribution template, and ingestion process.

Tasks

  • S-1: Write registry governance documentation (S) — Create docs/design/azd-tool/registry-governance.md documenting: registry ownership (azd team), approval process (PR review by azd maintainers), SLA for additions (<5 business days), ingestion model (PR with YAML entry + test validation), contribution template with all required fields. Reference pkg/extensions/registry.go as prior art for the extension registry model.
    • AC: Governance doc published; ownership/approval/SLA clearly defined; contribution template included with all required fields; ingestion process described (PR-based with CI validation); document reviewed and approved by team

Sequencing

No dependencies — can start immediately and run in parallel with any other work.

Dependencies

None. This is a standalone documentation task with no code dependencies.

Discussion Traceability

Discussion Item Task
S1 (registry curation) S-1

Design References

  • docs/design/azd-tool/plan.md — Standalone Tasks
  • docs/design/azd-tool/todos.md — S-1 acceptance criteria
  • pkg/extensions/registry.go — prior art for extension registry model
Dominant language
Go
Stars
569
Forks
365
Avg merge
2d 20h
Merged PRs (30d)
132

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/azure-dev

All issues in Azure/azure-dev

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.