Skip to content

Commit 3463e68

Browse files
committed
Refactor CLI architecture and reorganize specification
- Restructure CLI into modular architecture (constraints, vars, cache modules) - Rewrite CLI README with complete command documentation - Renumber spec chapters to sequential 01-12 format - Add formal W3C EBNF grammar with railroad diagrams - Add specification examples (minimal, complete, edge-cases) - Add CLI implementation guide for Rust developers - Add GitHub issue templates for community contributions
1 parent d8d311e commit 3463e68

50 files changed

Lines changed: 9709 additions & 1179 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug in the ACP specification, CLI, schemas, or tooling
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to report a bug! Please fill out the sections below to help us understand and resolve the issue.
12+
13+
- type: dropdown
14+
id: component
15+
attributes:
16+
label: Component
17+
description: Which part of ACP is affected?
18+
options:
19+
- Specification (ACP-1.0.md)
20+
- CLI (acp command)
21+
- MCP Server (acp-mcp-server)
22+
- JSON Schemas
23+
- Documentation
24+
- VS Code Extension
25+
- Other (please specify)
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
id: spec-chapter
31+
attributes:
32+
label: Specification Chapter
33+
description: If this relates to the specification, which chapter?
34+
options:
35+
- N/A - Not specification related
36+
- "01 - Introduction"
37+
- "02 - Terminology"
38+
- "03 - Cache Format"
39+
- "04 - Config Format"
40+
- "05 - Annotations"
41+
- "06 - Constraints"
42+
- "07 - Variables"
43+
- "08 - Inheritance & Cascade"
44+
- "09 - Discovery"
45+
- "10 - Querying"
46+
- "11 - Versioning"
47+
- "12 - Debug Sessions"
48+
- "Appendix A - Annotation Reference"
49+
- "Appendix B - JSON Schema Reference"
50+
- "Appendix C - Language Support"
51+
validations:
52+
required: true
53+
54+
- type: dropdown
55+
id: file-format
56+
attributes:
57+
label: File Format
58+
description: If this relates to a file format, which one?
59+
options:
60+
- N/A - Not file format related
61+
- ".acp.cache.json (Cache)"
62+
- ".acp.config.json (Config)"
63+
- ".acp.vars.json (Variables)"
64+
- ".acp.dir.json (Directory Config)"
65+
- "JSON Schema files"
66+
validations:
67+
required: true
68+
69+
- type: dropdown
70+
id: severity
71+
attributes:
72+
label: Severity
73+
description: How severe is this bug?
74+
options:
75+
- "Critical - Blocks usage entirely"
76+
- "High - Major feature broken"
77+
- "Medium - Feature impaired but workaround exists"
78+
- "Low - Minor inconvenience"
79+
- "Trivial - Cosmetic or typo"
80+
validations:
81+
required: true
82+
83+
- type: input
84+
id: version
85+
attributes:
86+
label: ACP Version
87+
description: Which version of ACP are you using?
88+
placeholder: "e.g., 1.0.0"
89+
validations:
90+
required: true
91+
92+
- type: input
93+
id: tool-version
94+
attributes:
95+
label: Tool Version
96+
description: If using CLI/MCP Server, which version?
97+
placeholder: "e.g., acp-cli 0.1.0"
98+
validations:
99+
required: false
100+
101+
- type: dropdown
102+
id: language
103+
attributes:
104+
label: Programming Language
105+
description: If language-specific, which language?
106+
options:
107+
- N/A - Not language specific
108+
- TypeScript
109+
- JavaScript
110+
- Python
111+
- Rust
112+
- Go
113+
- Java
114+
- C#
115+
- C/C++
116+
- Ruby
117+
- PHP
118+
- Swift
119+
- Kotlin
120+
- Other (please specify)
121+
validations:
122+
required: true
123+
124+
- type: textarea
125+
id: description
126+
attributes:
127+
label: Bug Description
128+
description: A clear and concise description of the bug
129+
placeholder: Describe what went wrong...
130+
validations:
131+
required: true
132+
133+
- type: textarea
134+
id: expected
135+
attributes:
136+
label: Expected Behavior
137+
description: What did you expect to happen?
138+
placeholder: Describe what you expected...
139+
validations:
140+
required: true
141+
142+
- type: textarea
143+
id: actual
144+
attributes:
145+
label: Actual Behavior
146+
description: What actually happened?
147+
placeholder: Describe what actually happened...
148+
validations:
149+
required: true
150+
151+
- type: textarea
152+
id: reproduction
153+
attributes:
154+
label: Steps to Reproduce
155+
description: How can we reproduce this bug?
156+
placeholder: |
157+
1. Create a file with...
158+
2. Run command...
159+
3. Observe error...
160+
value: |
161+
1.
162+
2.
163+
3.
164+
validations:
165+
required: true
166+
167+
- type: textarea
168+
id: code-sample
169+
attributes:
170+
label: Code Sample
171+
description: If applicable, provide a minimal code sample that demonstrates the issue
172+
render: typescript
173+
placeholder: |
174+
/**
175+
* @acp:lock frozen
176+
*/
177+
function example() {}
178+
validations:
179+
required: false
180+
181+
- type: textarea
182+
id: error-output
183+
attributes:
184+
label: Error Output
185+
description: If applicable, paste any error messages or logs
186+
render: shell
187+
placeholder: |
188+
$ acp index
189+
Error: ...
190+
validations:
191+
required: false
192+
193+
- type: textarea
194+
id: environment
195+
attributes:
196+
label: Environment
197+
description: Please provide relevant environment details
198+
placeholder: |
199+
- OS: macOS 14.0 / Ubuntu 22.04 / Windows 11
200+
- Node.js: 20.x (if applicable)
201+
- Rust: 1.75 (if applicable)
202+
- Shell: bash / zsh / PowerShell
203+
validations:
204+
required: false
205+
206+
- type: textarea
207+
id: workaround
208+
attributes:
209+
label: Workaround
210+
description: Have you found a workaround? If so, please share it.
211+
placeholder: Describe any workaround you've found...
212+
validations:
213+
required: false
214+
215+
- type: textarea
216+
id: additional
217+
attributes:
218+
label: Additional Context
219+
description: Add any other context, screenshots, or files about the bug
220+
placeholder: Any additional information...
221+
validations:
222+
required: false
223+
224+
- type: checkboxes
225+
id: checklist
226+
attributes:
227+
label: Checklist
228+
description: Please confirm the following
229+
options:
230+
- label: I have searched existing issues to ensure this bug hasn't been reported
231+
required: true
232+
- label: I have provided all requested information
233+
required: true
234+
- label: I am using a supported version of ACP
235+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://acp-protocol.dev/docs
5+
about: Check the documentation before asking questions
6+
- name: 💬 Discussions
7+
url: https://github.com/acp-protocol/acp-spec/discussions
8+
about: For general discussions, ideas, and community chat
9+
- name: 🔒 Security Issues
10+
url: https://github.com/acp-protocol/acp-spec/security/policy
11+
about: Report security vulnerabilities privately
12+
- name: 📜 RFC Process
13+
url: https://github.com/acp-protocol/acp-spec/blob/main/rfcs/TEMPLATE.md
14+
about: Learn about the RFC process for major changes

0 commit comments

Comments
 (0)