Skip to content

docs: trim AGENTS.md, delegate workflows to agent skills - #15

Merged
nikku merged 6 commits into
mainfrom
nikku-trim-agents-md-pr-section
Sep 9, 2026
Merged

nikku merged 6 commits into
mainfrom
nikku-trim-agents-md-pr-section

Conversation

@nikku

@nikku nikku commented Sep 9, 2026 •

Copy link
Copy Markdown
Member

Proposed Changes

Procedural instructions in AGENTS.md get dropped by agents under context pressure, and rules duplicated between instructions and skills drift apart. This PR establishes the split: AGENTS.md carries facts, contracts, and pointers; skills are the sole authority for running a workflow; a missing skill is surfaced to the user instead of worked around.

Depends on https://github.com/bpmn-io/ai-first/pull/2

Checklist

Ensure you provide everything we need to review your contribution:

  • Contribution meets our definition of done
  • Pull request establishes context
    • Link to related issue(s), i.e. Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}
    • Brief textual description of the changes
    • Screenshots or short videos showing UI/UX changes
    • Steps to try out, i.e. using the @bpmn-io/sr tool

@nikku
nikku requested review from a team and a lite review from Copilot September 9, 2026 12:15
@bpmn-io-tasks bpmn-io-tasks Bot added the needs review Review pending label Sep 9, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Documentation-only change is consistent with the PR description and preserves the mandatory template requirement.

Pull request overview

This PR updates the repository contribution guide to delegate the full pull request creation procedure to the bpmn-io-create-pr skill, keeping only the mandatory PR template requirement in AGENTS.md.

Changes:

  • Replaces the detailed PR creation checklist in AGENTS.md with a pointer to the bpmn-io-create-pr skill.
  • Retains and expands the mandatory PR template requirement, including an explicit note to fetch the org template via curl when it’s not in the local checkout.
File summaries
File Description
AGENTS.md Simplifies “Creating Pull Requests” by referencing bpmn-io-create-pr while preserving the required PR template instructions.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@nikku
nikku marked this pull request as draft September 9, 2026 12:36
@bpmn-io-tasks bpmn-io-tasks Bot added in progress Currently worked on and removed needs review Review pending labels Sep 9, 2026
@nikku

nikku commented Sep 9, 2026

Copy link
Copy Markdown
Member Author

This is an attempt to correct the PR creation mess - a dedicated skill will follow.

@nikku
nikku force-pushed the nikku-trim-agents-md-pr-section branch from f119a52 to fb2bb7e Compare September 9, 2026 12:39
Shrink AGENTS.md 'Creating Pull Requests' section to a pointer; the
bpmn-io-create-pr skill now carries the full procedure (history,
self-review, mandatory template, body contents). Missing skill must be
surfaced to the user, not worked around with inline rules.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@nikku
nikku force-pushed the nikku-trim-agents-md-pr-section branch from fb2bb7e to 742a500 Compare September 9, 2026 12:39
Shrink AGENTS.md 'Creating Issues' section to a pointer; the
bpmn-io-create-issue skill now carries the full procedure (template
discovery, contents, labels). Missing skill must be surfaced to the
user, not worked around with inline rules.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@nikku nikku changed the title docs: delegate PR creation procedure to bpmn-io-create-pr skill docs: delegate PR and issue creation to agent skills Sep 9, 2026
nikku and others added 3 commits September 9, 2026 15:11
The 'spaces, single-quotes' rule is mechanically enforced by the
linter; no need to spell it out as prose.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Fold the 'do not be overly verbose' rule into the purpose-oriented
JSDoc guidance so the section stays tight without losing meaning.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@nikku nikku changed the title docs: delegate PR and issue creation to agent skills docs: trim AGENTS.md, delegate workflows to agent skills Sep 9, 2026
Upstream library changes reach the reporter's repo only via release
and downstream integration, so they must reference the issue with
'Related to' instead of 'Closes'.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@nikku
nikku marked this pull request as ready for review September 9, 2026 15:18
@bpmn-io-tasks bpmn-io-tasks Bot added needs review Review pending and removed in progress Currently worked on labels Sep 9, 2026
@nikku
nikku merged commit fe0b52e into main Sep 9, 2026
4 checks passed
@bpmn-io-tasks bpmn-io-tasks Bot removed the needs review Review pending label Sep 9, 2026
@nikku
nikku deleted the nikku-trim-agents-md-pr-section branch September 9, 2026 18:16
Comment thread AGENTS.md

## Code Style

* Spaces instead of tabs; single-quotes

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good change. We have a linter for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants