Skip to content

Commit c69ee69

Browse files
committed
docs(specs): add agent instructions comment to existing specs
Adds a hidden agent instructions comment to every existing spec. The comment tells agents how to amend a spec based on the status of its parent ticket. No other change. Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev>
1 parent 76a6c86 commit c69ee69

10 files changed

Lines changed: 120 additions & 0 deletions

‎docs/specs/issue-3063-attestation-repo-config.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3063
55
prd:
66
---
77

8+
<!--
9+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
10+
11+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
12+
13+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
14+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
15+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
16+
17+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
18+
-->
19+
820
# Spec issue-3063: Project and Organization from .chainloop.yml in Attestations
921

1022
## Summary

‎docs/specs/issue-3495-session-spec-capture.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3495
55
prd:
66
---
77

8+
<!--
9+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
10+
11+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
12+
13+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
14+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
15+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
16+
17+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
18+
-->
19+
820
# Spec issue-3495: Spec capture for AI coding sessions
921

1022
## Summary

‎docs/specs/issue-3515-spec-capture-during-session.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3515
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3515: Spec capture during the session
820

921
## Summary

‎docs/specs/issue-3520-pi-trace-provider.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3520
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3520: Pi coding agent support in Chainloop Trace
820

921
## Summary

‎docs/specs/issue-3531-spec-source-role.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3531
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3531: Role, title, and description of each spec source
820

921
## Summary

‎docs/specs/issue-3540-trace-skills-used.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3540
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3540: Skills used in a Chainloop Trace session
820

921
## Summary

‎docs/specs/issue-3543-cas-existence-cache.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3543
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3543: Existence cache in the Artifact CAS
820

921
## Summary

‎docs/specs/issue-3549-cas-download-browser-cache.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3549
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3549: Browser cache for CAS downloads
820

921
## Summary

‎docs/specs/issue-3556-session-image-placeholders.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3556
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3556: Pointers to spec sources in the AI coding session transcript
820

921
## Summary

‎docs/specs/issue-3561-up-to-date-local-spec-evidence.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ ticket: https://github.com/chainloop-dev/chainloop/issues/3561
44
prd:
55
---
66

7+
<!--
8+
AGENT INSTRUCTIONS. Keep this comment. Read it before you change this file.
9+
10+
This spec records a design that humans reviewed and approved. Do not change it as part of other work. Find the status of the parent ticket (the `ticket:` field) before you change anything. If you cannot find the status, or you are not sure which case below applies, do not change the spec. Ask the human first.
11+
12+
- Ticket in design, and the spec PR is open: change the spec only through the br:eng-spec skill (`--revise`). Never renumber or reuse an R-xxx or D-xxx ID.
13+
- Ticket in progress: do not rewrite the requirements, the Proposal, or existing Decision Record rows. Record a changed decision as a new Decision Record row. The owner records the differences with the shipped work through br:eng-spec (`--done`).
14+
- Ticket done or canceled: the spec is frozen. Do not change, delete, or strike through any text. The only allowed edits are typo fixes, broken links, and the "Superseded by" line under the title. For a design change, write a new spec with br:eng-spec that supersedes this one.
15+
16+
When your code goes against this spec, say so in your PR. Do not edit the spec to match the code.
17+
-->
18+
719
# Spec issue-3561: Up-to-date spec evidence for local sources
820

921
## Summary

0 commit comments

Comments
 (0)