docs(meta): document issue types, area labels, and release milestones#546
docs(meta): document issue types, area labels, and release milestones#546Ethan-Arrowood wants to merge 1 commit into
Conversation
Record the issue-tracking conventions across the contributor-facing docs: - CONTRIBUTING.md: add a "Reporting Issues" section — the four forms, issue types (Bug/Feature/Task), area labels (content/platform, no subsystem labels), and v5.x release milestones for per-release docs tracking. - AGENTS.md: add an "Issues & Project Management" section mirroring the above for agents (don't reintroduce bug/enhancement labels; don't delete the release milestones). - README.md: note the type/area/milestone organization and link to the guide. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the project's documentation (AGENTS.md, CONTRIBUTING.md, and README.md) to define and explain the issue management workflow, including issue types, area labels, and release milestones. The review feedback suggests improving navigability by linking directly to the reporting section in AGENTS.md and formatting issue types in bold within README.md for consistency across files.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| - **Area labels:** `content` (documentation text/examples) vs `platform` (the docs site itself — build, search, navigation, styling). These are the only area labels; there are no per-subsystem labels. | ||
| - Kind is captured by the issue **type**, not labels — do not reintroduce `bug`/`enhancement` labels. | ||
| - **Milestones:** `v5.x` release milestones, named to match the `harper`/`harper-pro` repos. Tag an issue with the milestone of the release whose docs it must ship with, so docs work is tracked per release. Do not delete the empty release milestones — they are the canonical per-release buckets. | ||
| - See `CONTRIBUTING.md` (Reporting Issues) for the contributor-facing version. |
There was a problem hiding this comment.
To improve navigability, consider linking directly to the Reporting Issues section in CONTRIBUTING.md instead of using plain text backticks.
| - See `CONTRIBUTING.md` (Reporting Issues) for the contributor-facing version. | |
| - See [CONTRIBUTING.md (Reporting Issues)](CONTRIBUTING.md#reporting-issues) for the contributor-facing version. |
| This documentation site is open source! | ||
|
|
||
| If you notice something out-of-place or have suggestions for improvement, please feel free to submit an issue and/or a pull request. Make sure to follow the relevant bug report and content/feature request templates. | ||
| If you notice something out-of-place or have suggestions for improvement, please feel free to submit an issue and/or a pull request. Issues are filed through templates and organized by **type** (Bug / Feature / Task), **area** (`content` / `platform`), and **release milestone** (`v5.x`). |
There was a problem hiding this comment.
For consistency with CONTRIBUTING.md and AGENTS.md, the issue types (Bug, Feature, Task) should be bolded as Bug / Feature / Task.
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-546 This preview will update automatically when you push new commits. |
1 participant
Summary
Records the issue-tracking conventions (from the docs-repo PM cleanup) in the contributor-facing meta docs, so they're discoverable and durable:
CONTRIBUTING.md— new Reporting Issues section: the four issue forms, issue types (Bug/Feature/Task), area labels (content/platform, and why there are no per-subsystem labels), andv5.xrelease milestones for tracking docs work per release alongsideharper/harper-pro.AGENTS.md— new Issues & Project Management section mirroring the above for agents (kind is carried by type, not labels; don't reintroducebug/enhancement; don't delete the empty release milestones).README.md— note the type/area/milestone organization and link to the guide (also drops the now-stale "bug report" template wording).Notes
config.yml). Together these make the type/label/milestone model the documented norm.v5.xrelease milestones to track docs work per release. The emptyv5.1/v5.2milestones are kept (not deleted) as the canonical per-release buckets.🤖 Generated with Claude Code