diff --git a/README.md b/README.md index b9d4673..6392f0b 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,6 @@ benchmarks/ - `docs/guides/adding-scenarios.md` - how to add parity scenarios - `docs/guides/benchmark-workflow.md` - benchmark and reporting flow - `docs/guides/benchmark-publication-policy.md` - minimum disclosure for publishable results -- `docs/guides/repository-metadata.md` - repository metadata and positioning **Governance:** - `MAINTAINERS.md` - maintainership roles and triage expectations diff --git a/ROLLOUT_CHECKLIST.md b/ROLLOUT_CHECKLIST.md deleted file mode 100644 index 2c9e47b..0000000 --- a/ROLLOUT_CHECKLIST.md +++ /dev/null @@ -1,36 +0,0 @@ -# OSS Hardening and OMO Enablement - Rollout Checklist - -## Summary -All 16 tasks completed successfully. Work is ready for PR. - -## Branch -- **Branch**: feat/oss-hardening-and-omo-enablement -- **Worktree**: .worktrees/feat-oss-hardening/ -- **Commits**: 7 commits ahead of main - -## Files Changed -1. LICENSE (new) - MIT License -2. MAINTAINERS.md (new) - Governance doc -3. README.md - Badge row, modkit narrative, trust section -4. docs/guides/AGENTS.md - Guide index updates -5. docs/guides/benchmark-publication-policy.md (new) - Publication policy -6. docs/guides/repository-metadata.md (new) - Metadata profile - -## Suggested PR Sequence - -### PR 1: Legal and Baseline Trust - - -### PR 2: Governance and Positioning - - -### PR 3: OMO Setup Guide - - -## Post-Merge Actions -1. Apply GitHub metadata via commands in docs/guides/repository-metadata.md -2. Verify badges render correctly on README -3. Confirm docs/guides navigation works - -## Evidence -See .sisyphus/evidence/task-8-final-gate.txt for verification output. diff --git a/docs/guides/AGENTS.md b/docs/guides/AGENTS.md index aa32981..751150b 100644 --- a/docs/guides/AGENTS.md +++ b/docs/guides/AGENTS.md @@ -15,7 +15,6 @@ Operator-facing guides for parity contract usage, scenario authoring, and benchm | Add or modify scenarios safely | `docs/guides/adding-scenarios.md` | Endpoint-grouped workflow + checklist | | Run benchmark pipeline | `docs/guides/benchmark-workflow.md` | Standard, per-target, and artifact expectations | | Publish benchmark results | `docs/guides/benchmark-publication-policy.md` | Minimum disclosure for publishable results | -| Manage repo metadata | `docs/guides/repository-metadata.md` | Description, topics, and gh commands | | View maintainership info | `MAINTAINERS.md` | Roles, triage SLA, and escalation | diff --git a/docs/guides/repository-metadata.md b/docs/guides/repository-metadata.md deleted file mode 100644 index f896ef8..0000000 --- a/docs/guides/repository-metadata.md +++ /dev/null @@ -1,55 +0,0 @@ -# Repository Metadata Profile - -This document defines the GitHub repository metadata for the `benchmarks` project. Maintaining accurate metadata ensures discoverability and clear positioning within the `go-modkit` ecosystem. - -## Metadata Profile - -| Field | Value | -|-------|-------| -| **Description** | Parity-gated benchmark harness for API framework performance comparison. Ensures correctness via declarative contract fixtures before measuring throughput and latency. | -| **Topics** | `go`, `benchmark`, `api-parity`, `performance-testing`, `reproducibility`, `modkit`, `framework-comparison`, `api-contract`, `docker-orchestration`, `quality-gates` | -| **Homepage** | `https://github.com/go-modkit/benchmarks` | - -## Application Checklist - -### Automated (via GitHub CLI) - -If you have the `gh` CLI installed and authenticated, run the following command to apply the profile: - -```bash -gh repo edit go-modkit/benchmarks \ - --description "Parity-gated benchmark harness for API framework performance comparison. Ensures correctness via declarative contract fixtures before measuring throughput and latency." \ - --add-topic "go,benchmark,api-parity,performance-testing,reproducibility,modkit,framework-comparison,api-contract,docker-orchestration,quality-gates" \ - --homepage "https://github.com/go-modkit/benchmarks" -``` - -### Manual Fallback - -If the GitHub CLI is unavailable, follow these steps: - -1. Navigate to the repository on GitHub: [go-modkit/benchmarks](https://github.com/go-modkit/benchmarks) -2. Click on the **Settings** gear icon (or the "About" section edit icon on the main page). -3. In the **Description** field, paste: - > Parity-gated benchmark harness for API framework performance comparison. Ensures correctness via declarative contract fixtures before measuring throughput and latency. -4. In the **Website** field, paste: - > https://github.com/go-modkit/benchmarks -5. In the **Topics** section, add the following tags one by one: - - `go` - - `benchmark` - - `api-parity` - - `performance-testing` - - `reproducibility` - - `modkit` - - `framework-comparison` - - `api-contract` - - `docker-orchestration` - - `quality-gates` -6. Click **Save changes**. - -## Verification - -To verify the current metadata, run: - -```bash -gh repo view go-modkit/benchmarks --json description,repositoryTopics,homepage -```