feat: add Simplified Technical English skill - #5
Merged
Conversation
|
ⓘ Your Qodo trial ends soon. Ask your workspace admin to set up billing to keep reviews running after the trial. Manage billing |
PR Summary by QodoAdd Simplified Technical English skill and register it in the knowledge bundle
AI Description
Diagram
High-Level Assessment
Files changed (6)
|
Code Review by Qodo
Context used✅ Compliance rules (platform):
161 rules✅ Skills:
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
| name: simplified-technical-english | ||
| title: "Simplified Technical English" | ||
| description: "Write and revise technical content so labels, headings, instructions, plans, status names, error messages, identifiers, and Git branches are clear without hidden context. Use when creating or reviewing technical documentation, operational procedures, UI labels, project phases or gates, issue and PR titles, and branch names; especially when text contains unexplained shorthand, vague labels, long instructions, inconsistent terms, or branches such as work/updates that do not identify the change type and topic." | ||
| resource: "https://en.wikipedia.org/wiki/Simplified_Technical_English" |
There was a problem hiding this comment.
1. Resource metadata inconsistent 🐞 Bug ⚙ Maintainability
The new skill’s SKILL.md sets frontmatter resource to a Wikipedia page, unlike the rest of the repo where resource consistently points to the canonical GitHub skill directory URL. This makes resource inconsistent with the bundle’s kb:format convention and with other skills’ metadata.
Agent Prompt
## Issue description
The `resource` frontmatter field for `simplified-technical-english` points to Wikipedia, while this repository’s convention uses `resource` as the canonical URL for the skill package in this repo.
## Issue Context
- `scripts/apply-okf-conventions.mjs` (run via `npm run kb:format`) populates `resource` with the GitHub tree URL when missing, and all existing skills use that same pattern.
- You can still keep the Wikipedia link as a *source citation* in the body (or in a `## Source` / `## Citations` section); the fix is about what `resource` represents.
## Fix Focus Areas
- skills/simplified-technical-english/SKILL.md[1-10]
- scripts/apply-okf-conventions.mjs[86-97]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Comment on lines
+202
to
+219
| "name": "simplified-technical-english", | ||
| "path": "skills/simplified-technical-english", | ||
| "origin": "authored", | ||
| "license": "MIT", | ||
| "tags": [ | ||
| "documentation", | ||
| "technical-writing", | ||
| "naming", | ||
| "git", | ||
| "workflow" | ||
| ], | ||
| "publish_decision": "candidate", | ||
| "provenance": { | ||
| "summary": "Original dirtybits-authored guidance informed by the public Simplified Technical English overview.", | ||
| "attribution_notes": [ | ||
| "Uses general clarity principles and original examples; does not reproduce or claim formal compliance with ASD-STE100." | ||
| ] | ||
| } |
There was a problem hiding this comment.
2. Log entry missing 🐞 Bug ⚙ Maintainability
This PR adds a new skill (and updates generated indexes) but does not add a corresponding entry to log.md, reducing the bundle’s semantic change history. The repo conventions describe log.md as the chronological semantic update history.
Agent Prompt
## Issue description
A new skill was added, but `log.md` was not updated to record the semantic change.
## Issue Context
`KB_CONVENTIONS.md` describes `log.md` as the chronological semantic update history for the knowledge bundle.
## Fix Focus Areas
- log.md[1-15]
- KB_CONVENTIONS.md[32-39]
- registry.json[202-219]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
simplified-technical-englishskill for clear technical labels, headings, instructions, and status namesBase Sepolia Gate A — Pre-deployment verificationfix/wallet-connect-button-handlingTest plan
npm run kb:formatnpm run validate— validated 18 skillsagents/openai.yamland confirmed the default prompt names$simplified-technical-englishValidation note
The generic skill-creator
quick_validate.pyrejects this repository's required OKF frontmatterkeys (
type,title,resource,tags,timestamp, andokf_version). The repository validatoraccepts and requires that metadata, so
npm run validateis the authoritative structural gate.