docs: align issue templates and contributing guide with label taxonomy - #444
JohnsonLyu wants to merge 3 commits into
Conversation
mlieberman85
left a comment
mlieberman85
left a comment
There was a problem hiding this comment.
The type: frontmatter works -- the org has Bug and Feature enabled. Taking #437's taxonomy as settled, this is close. Four things to add.
1. The labels don't exist yet, and unknown labels get dropped silently. Dependabot PR #440 has zero labels right now, because .github/dependabot.yml asks for dependencies and ci and neither exists. needs triage will go the same way: new issues would land with no label, where today they get bug or enhancement. The label changes in #437 need to land before or with this PR.
2. Do the label changes as code. Nothing in the repo creates labels today. A .github/labels.yml manifest plus a sync workflow makes the taxonomy reviewable in a PR and keeps it from drifting away from these templates. Pin the action by SHA like the other workflows here.
3. needs triage won't reach every issue. .github/ISSUE_TEMPLATE/config.yml sets blank_issues_enabled: true, so issues opened without a template skip both files changed here. Set it to false, or add a labeler workflow on issues: opened.
4. dependencies, python and ci are in use but absent from the taxonomy. They come from dependabot.yml. Either add them to #437's list or point dependabot at labels that exist.
Closes #437 also covers the GitHub-side label work, which isn't in this diff. If that lands separately, use Refs #437.
| - `module-core` — darnit core | ||
| - `module-baseline` — OpenSSF Baseline module | ||
| - `module-amber` — Amber module | ||
| - `interface-cli` — command-line interface | ||
| - `interface-mcp` — MCP interface |
There was a problem hiding this comment.
#437 notes that future modules each get a module-<name> label. State the convention here -- gittuf and reproducibility ship today and csl arrives in #449, so the next plugin author needs the rule, not just three examples.
| - `module-core` — darnit core | |
| - `module-baseline` — OpenSSF Baseline module | |
| - `module-amber` — Amber module | |
| - `interface-cli` — command-line interface | |
| - `interface-mcp` — MCP interface | |
| - `module-core` — darnit core | |
| - `module-baseline` — OpenSSF Baseline module | |
| - `module-amber` — Amber module | |
| - `interface-cli` — command-line interface | |
| - `interface-mcp` — MCP interface | |
| Each module gets its own `module-<name>` label as it lands. |
|
Should we delete bug and enhancement now, or keep them until existing issues are backfilled with issue types? |
Signed-off-by: Johnson Lyu <cl7084@nyu.edu>
Co-authored-by: Michael Lieberman <mlieberman85@gmail.com> Signed-off-by: Johnson Lyu <cl7084@nyu.edu>
Labels referenced by the issue templates and dependabot did not exist, so GitHub silently dropped them. Sync the taxonomy from a manifest and guarantee needs triage on every opened issue, including blank ones. Signed-off-by: Johnson Lyu <cl7084@nyu.edu>
9550774 to
4f10461
Compare
| description: "darnit core framework" | ||
| - name: "module-baseline" | ||
| color: "#1d76db" | ||
| description: "OpenSSF Baseline module" |
There was a problem hiding this comment.
| description: "OpenSSF Baseline module" | |
| description: "OSPS Baseline module" |
3 participants
Closes #437
Summary
bug/enhancement; use issue types plusneeds triageupstream-spec-check.ymlfrom applying themaintenancelabelType of Change
Framework Changes Checklist
N/A
Control/TOML Changes Checklist
N/A
Testing
uv run pytest tests/ -v)uv run ruff check .)Docs/templates only; no code tests needed.
AI assistance
Cursor: reviewed remaining gaps and helped with PR wording.
Additional Notes
This PR covers the in-repo parts of #437. Creating, renaming, and deleting GitHub labels still needs a maintainer after merge:
module-core,module-baseline,module-amber,needs triage,interface-mcpinvalid→closed-invalid,wontfix→closed-wontfix,cli→interface-cli,question→need infobug,enhancement,maintenance,ux,quality