camunda / camunda/c8ctl

AI-First compliance: AGENTS.md baseline

Open
#320 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
7
Forks
0
Avg merge
15h 36m
Merged PRs (30d)
28

Description

AI-First compliance check

Evaluated against camunda/ai-first-template.
Score: 15/15

Checklist
  • AGENTS.md present at repo root

    AGENTS.md is listed in the root directory output.

  • CLAUDE.md present at repo root

    CLAUDE.md is listed in the root directory output.

  • AGENTS.md header delegates to raw.githubusercontent.com/camunda/.github shared template

    AGENTS.md lines 3–7 contain the delegation block pointing to https://raw.githubusercontent.com/camunda/.github/refs/heads/main/AGENTS.md.

  • AGENTS.md contains a ## Repo-specific instructions section

    AGENTS.md contains the '## Repo-specific instructions' heading with extensive repo-specific content.

  • Role & boundary section contains real repo-specific content (service ownership, upstream deps, path map, entry points)

    AGENTS.md '### Role & boundary' section describes c8ctl as a Camunda 8 CLI, lists upstream deps, provides a detailed path map table, and specifies 'Entry points: src/index.ts'.

  • Architecture section contains real content (link to ADR/diagram, key components listed)

    AGENTS.md '### Architecture' section contains an ASCII architecture diagram and lists key components including command-registry.ts, command-dispatch.ts, command-framework.ts, and others.

  • Commit message guidelines are defined (type, scope, message format)

    AGENTS.md '### Commit message guidelines' section defines Conventional Commits format, allowed type values, subject rules, scope conventions, and multiple examples.

  • Build pipeline §4 contains three concrete commands (baseline verify, fast inner loop, full pre-push) — not template scaffolding

    AGENTS.md '### Build pipeline' section specifies three concrete commands: 'npm test' (baseline), 'npm run test:unit' (fast inner loop), and 'npm run build && npm test' (full pre-push).

  • No unresolved HTML TODO markers remain in AGENTS.md

    No HTML TODO comment markers were found anywhere in the AGENTS.md content.

  • No [bracketed placeholder] tokens remain in AGENTS.md

    No [bracketed placeholder] tokens are present in AGENTS.md; all bracketed references are real links (e.g. [README.md], [PLUGIN-HELP.md]).

  • CLAUDE.md delegates to AGENTS.md and does not duplicate guidelines

    CLAUDE.md contains only a brief note directing Claude to read and follow AGENTS.md, with no duplicated guidelines.

  • .github/copilot-instructions.md absent

    .github directory listing shows only SDK_GAPS.md, renovate.json, and workflows — no copilot-instructions.md present.

  • DEVELOPMENT.md absent

    Root directory listing does not include DEVELOPMENT.md.

  • CODING-GUIDELINES.md absent

    Root directory listing does not include CODING-GUIDELINES.md.

  • COMMIT-MESSAGE-GUIDELINE.md absent

    Root directory listing does not include COMMIT-MESSAGE-GUIDELINE.md.


Generated by ai-first-compliance. Re-runs nightly.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the repository-root AGENTS.md and CLAUDE.md against the checklist in this issue. The report already records all 15 checks as passing, so done would require a specific missing compliance item or documented change before any work can begin.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.