Skip to content
cccskills
FreePublished on GitHub

code-annotate

Generate boilerplate `# implements:` annotation for a function based on the artefact ID, inserting it as the first line of the function body.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.2 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

<!-- implements: DES-assured-skills-003 -->

Skill: code-annotate

Use this skill when adding implementation code that satisfies a REQ or DES. Generates the correct # implements: annotation, validates that the cited IDs exist in the registry, and inserts the annotation in a syntactically-correct place.

Inputs

  • <artefact-id> — the REQ or DES being implemented (e.g., REQ-auth-001, DES-auth-001, or P1.SP2.M3.REQ-007)
  • File path and function name (from active editing context)

Steps

  1. Verify the artefact exists. Read library/_ids.md; confirm <artefact-id> is declared.

  2. Detect the language. Python (#), JavaScript/TypeScript (//), Go (//), Rust (//). Default # if unknown.

  3. Determine the comment line. Choose the comment syntax matching the file extension.

  4. Insert the annotation. Place <comment-prefix> implements: <artefact-id> as the first line of the function body, immediately after the opening brace / : / func ... {.

  5. Confirm. Show the diff to the user.

  6. Run annotation_format_integrity on the file to verify the annotation parses correctly.

Annotation placement rules

<!-- implements: <DES-ID> --> and # implements: <DES-ID> annotations ALWAYS go on the implementing artefact:

  • A Python function body — first line of the body, comment form
  • A SKILL.md file — immediately after frontmatter close ---, HTML-comment form
  • A governance document — YAML frontmatter satisfies_by_existence: [...] or implements: [...]

NEVER place annotations:

  • Inside a design-spec.md DES element (the DES is what is satisfied, not what implements)
  • Inside a requirements-spec.md REQ element
  • Inside a test-spec.md TEST element

The spec layer expresses obligation; the implementing artefact carries evidence. Crossing the layers blurs the audit trail.

Done criteria

  • Annotation inserted in syntactically-correct location.
  • annotation_format_integrity passes.
  • One commit with the annotation; the implementing code is the user's responsibility.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Generate a GitHub Actions workflow for Android — JDK + Gradle caching, build, unit + instrumented tests, Android Lint, run the Android pre-flight checks, and (optionally) sign + upload a signed app bundle to a Play track. Use when setting up CI for an Android app.

The English summary is being prepared. Showing the original description.

SteveGJones/ai-first-sdlc-practices41Updated Oct 5, 2026

Validated Google Play release — runs the pre-flight checks and clears the Play policy gates, builds a signed app bundle with a git-stamped versionCode, uploads to a track, and walks staged rollout (with halt/roll-forward). Use when releasing an Android app to Play.

The English summary is being prepared. Showing the original description.

SteveGJones/ai-first-sdlc-practices41Updated Oct 5, 2026

Scaffold a new Android app with SDLC and Play-safe defaults — Kotlin/Compose Gradle project with version catalog, convention plugins, module layout, a targetSdk that meets the Play mandate, R8 on release, and git-ignored signing so it passes the pre-flight checker from day one. Use when starting a new Android project.

The English summary is being prepared. Showing the original description.

SteveGJones/ai-first-sdlc-practices41Updated Oct 5, 2026

Set up Android app signing safely — generate an upload keystore, enroll in Play App Signing, and wire a Gradle release signingConfig that reads secrets from a git-ignored keystore.properties / CI (never committed). Use when configuring signing for a Play release.

The English summary is being prepared. Showing the original description.

SteveGJones/ai-first-sdlc-practices41Updated Oct 5, 2026

Pick an existing workflow for a task or author a new one — recommends workflow + team formation, or generates a fresh workflow YAML with command prompts and team validation.

The English summary is being prepared. Showing the original description.

SteveGJones/ai-first-sdlc-practices41Updated Oct 5, 2026

Guide the team through writing a change-impact record for IEC 62304 / FDA / ISO 26262 ASIL C+ projects. Surfaces the affected REQ/DES/TEST/CODE artefacts and captures human-attested verification approach.

The English summary is being prepared. Showing the original description.

SteveGJones/ai-first-sdlc-practices41Updated Oct 5, 2026

See all skills by SteveGJones

Report a problem with this skill