Skip to content
Merged
112 changes: 9 additions & 103 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,126 +1,32 @@
name: Bug Report
description: Report an issue or inconsistency in the TOON specification
description: Report an error, contradiction, or ambiguity in the TOON specification
title: '[Bug]: '
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue with the TOON specification!

Please fill out the sections below to help us understand and address the problem.

- type: dropdown
id: bug-type
attributes:
label: Issue Type
description: What type of issue are you reporting?
options:
- Specification ambiguity or unclear language
- Contradiction in the specification
- Missing or incorrect examples
- Inconsistency between spec and test fixtures
- ABNF grammar issue
- Other specification error
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the issue.
placeholder: Describe what's wrong with the specification...
validations:
required: true

- type: textarea
id: spec-reference
attributes:
label: Specification Reference
description: Which section(s) of the specification are affected?
placeholder: |
E.g., Section 7.2, lines 320-325
Or: SPEC.md:320-325
validations:
required: true

- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: What does the specification currently say? (Quote the relevant text if possible)
placeholder: |
Currently, the spec states...
render: markdown
description: What the specification says, and what it should say instead.
validations:
required: true

- type: textarea
id: expected-behavior
- type: input
id: section
attributes:
label: Expected Behavior
description: What should the specification say instead? Or how should it be clarified?
placeholder: |
The spec should clarify that...
render: markdown
label: Section
placeholder: §9.3
validations:
required: true

- type: textarea
id: example
attributes:
label: Example
description: Provide a concrete example that demonstrates the issue.
description: A TOON document that shows the issue.
placeholder: |
```toon
items[2]{id,name}:
1,Alice
users[2]{id,name}:
1,Ada
2,Bob
```

According to Section X, this should..., but Section Y suggests...
render: markdown

- type: textarea
id: impact
attributes:
label: Impact
description: How does this issue affect implementations or users?
placeholder: |
- Implementations may interpret this differently
- This could lead to incompatible encoders/decoders
- Edge case X is not covered
validations:
required: true

- type: textarea
id: proposed-fix
attributes:
label: Proposed Fix
description: If you have a suggestion for how to fix this, please describe it here.
placeholder: |
I suggest updating Section 7.2 to explicitly state...

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other information that might be helpful (links to related issues, implementation behavior, etc.)
placeholder: |
- Related to #123
- The reference implementation handles this by...
- Other specifications like JSON/YAML handle this by...

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have searched for similar issues in the issue tracker
required: true
- label: I have checked the latest version of the specification
required: true
- label: This issue is about the specification itself (not implementation bugs)
required: true
80 changes: 10 additions & 70 deletions .github/ISSUE_TEMPLATE/clarification.yml
Original file line number Diff line number Diff line change
@@ -1,93 +1,33 @@
name: Specification Clarification
description: Request clarification on ambiguous or unclear parts of the specification
description: Ask what a part of the specification means
title: '[Clarification]: '
labels: [question, clarification]
labels: [question]
body:
- type: markdown
attributes:
value: |
Thank you for seeking clarification on the TOON specification!

This template is for questions about what the spec means or how it should be interpreted.
If you've found an error, please use the Bug Report template instead.

- type: textarea
id: question
attributes:
label: Question
description: What part of the specification needs clarification?
placeholder: I'm unclear about how...
validations:
required: true

- type: textarea
id: spec-reference
- type: input
id: section
attributes:
label: Specification Section
description: Which section(s) are you asking about?
placeholder: |
E.g., Section 9.3, "Arrays of Objects – Tabular Form"
validations:
required: true

- type: textarea
id: confusion
attributes:
label: Source of Confusion
description: What specifically is ambiguous or unclear?
placeholder: |
The specification says "X", but it's not clear if this means...
- Interpretation A: ...
- Interpretation B: ...
render: markdown
label: Section
placeholder: §9.3
validations:
required: true

- type: textarea
id: example
attributes:
label: Example Case
description: Provide a concrete example that demonstrates your question.
label: Example
description: A TOON document your question is about.
placeholder: |
For instance, given this TOON:
```toon
items[2]{id,name}:
1,Alice
users[2]{id,name}:
1,Ada
2,Bob
```

Should this be encoded as... or ...?
render: markdown
validations:
required: true

- type: textarea
id: context
attributes:
label: Use Case / Context
description: Why does this clarification matter? What are you trying to implement or understand?
placeholder: |
I'm implementing a TOON encoder and need to know...
Or: I'm writing test cases for...

- type: textarea
id: tested-behavior
attributes:
label: Reference Implementation Behavior
description: Have you checked how the reference implementation handles this? What does it do?
placeholder: |
The reference implementation in JavaScript does X...
Or: I haven't tested this yet.

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have read the relevant specification sections
required: true
- label: I have searched for similar questions in existing issues
required: true
- label: I have checked the examples in the specification
required: true
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 💬 GitHub Discussions
- name: GitHub Discussions
url: https://github.com/toon-format/spec/discussions
about: Ask questions, share ideas, or discuss the specification with the community
- name: 📖 Read the Specification
- name: Read the Specification
url: https://github.com/toon-format/spec/blob/main/SPEC.md
about: Read the complete TOON specification
- name: 🧪 Test Fixtures
- name: Test Fixtures
url: https://github.com/toon-format/spec/tree/main/tests
about: Browse language-agnostic test fixtures for validating implementations
- name: 💻 Reference Implementation
- name: Reference Implementation
url: https://github.com/toon-format/toon
about: TypeScript/JavaScript reference implementation with encoder, decoder, and CLI
Loading
Loading