[BRE-1830] feat(bitwarden-devops-engineer): Add naming conventions - #192
[BRE-1830] feat(bitwarden-devops-engineer): Add naming conventions#192fntyler wants to merge 5 commits into
Conversation
Add a `workflow-naming-conventions` reference skill covering the GitHub Actions naming standards that `bwwl` does not enforce, so audits stop relying on undocumented convention. The skill defers to `bitwarden-workflow-linter-rules` for every linted rule to avoid double-reporting, and treats job ID and file renames as report-only because both are addressable identifiers. * Document job IDs (kebab-case), step names (Sentence case with a leading imperative verb), and workflow file names (kebab-case.yml, `_` prefix when exclusively reusable) * Add reference-sweep procedures for job ID and filename renames, plus an advisory canonical step-name glossary * Bump plugin to 0.2.0 with changelog entry and README listing * Add `greppable` to the cspell dictionary
Claude Configuration Validation — PR #192Result: PASS. No critical or major issues. One plugin changed (
1. Plugin ValidationValidated
2. Skill ReviewReviewed
3. Configuration & Security Review
FindingsCritical (0)None. Major (0)None. Minor — warnings (should fix)
Minor — nits (optional)
Notable Strengths
VerdictApprove. All three validation passes succeeded, and formatting and spell checks were confirmed clean by running the CI tooling locally. The six findings are polish and consistency items; the highest-value follow-ups are adding |
🤖 Bitwarden Claude Code ReviewOverall Assessment: APPROVE This PR adds a Code Review Details
|
| @@ -0,0 +1,122 @@ | |||
| --- | |||
| name: workflow-naming-conventions | |||
There was a problem hiding this comment.
Any reason not to include something like user-invocable: false for skill definitions of this style/type? Frontmatter reference
There was a problem hiding this comment.
Generally speaking, no, but I'm curious how you envision it to be used if it's not. Will it be referenced in another skill or agent somewhere? Also curious why you wouldn't want a user to be able to invoke it.
There was a problem hiding this comment.
I was unaware of user-invocable or disable-model-invocation controls for skills prior to working on this one. In this case, this skill is more of a reference (similar to bitwarden-workflow-linter-rules) which I think are better served if invoked by an agent or another skill.
SaintPatrck
left a comment
There was a problem hiding this comment.
Consider having Skill Creator generate evals to provide evidence that all the prose within the new Skill is actually load-bearing, and not overly verbose as Claude likes to do. Without evals, objective review of the Skill content is impossible unless reviewers run and evaluate it manually.
| @@ -0,0 +1,122 @@ | |||
| --- | |||
| name: workflow-naming-conventions | |||
There was a problem hiding this comment.
Generally speaking, no, but I'm curious how you envision it to be used if it's not. Will it be referenced in another skill or agent somewhere? Also curious why you wouldn't want a user to be able to invoke it.
Bring the `workflow-naming-conventions` skill description in line with the skill spec, which forbids XML tags in `description`. Trigger phrasings are folded into prose so the skill still matches the same potential user questions.
Disambiguate this skill's rule IDs from real `bwwl` rule IDs. The three standards are code-fenced headings styled exactly like linter rules, and only kebab-vs-snake casing separates them, so a reader of a generated report could mistake a convention finding for linter output.
Address the ownership line's source-of-truth pointer with a resolvable path instead of a bare skill name, matching the form `action-audit` uses to reach the same skill.
Align the two sentence case headings in `workflow-naming-conventions` with the Title Case used across the plugin's other skill headings. Cosmetic only. * `## Advisory: canonical step names` to `## Advisory: Canonical Step Names` * `## Applying these standards` to `## Applying These Standards`
🎟️ Tracking
BRE-1830
📔 Objective
Add a
workflow-naming-conventionsreference skill covering the GitHub Actions naming standards thatbwwldoes not enforce, so audits stop relying on undocumented convention.The skill defers to
bitwarden-workflow-linter-rulesfor every linted rule to avoid double-reporting, and treats job ID and file renames as report-only because both are addressable identifiers._prefix when exclusively reusable)greppableto the cspell dictionary