studio/marathon
2
0
Fork 0
Code Issues 121 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: added issue templates and rfcs

Browse Source 
Signed-off-by: Sienna Meridian Satterwhite <sienna@r3t.io>
This commit is contained in:
Sienna Meridian Satterwhite
2025-12-16 21:22:28 +00:00
parent 5cafe89e4f
commit 6b994aa7c4
9 changed files with 2701 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,84 @@
name: Bug Report
description: Report a bug or unexpected behavior
labels: ["bug"]
type: "Task"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this bug!
- type: textarea
id: description
attributes:
label: Description
description: Describe the bug using the "In order to" format
placeholder: |
In order to [achieve some goal/benefit],
as a [type of user],
I need [the bug to be fixed/expected behavior].
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: Describe what currently happens using Given/When/Then format
placeholder: |
```gherkin
Scenario: Bug occurs
Given [initial context/state]
When [action is taken]
Then [unexpected outcome/bug behavior]
```
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Describe what should happen using Given/When/Then format
placeholder: |
```gherkin
Scenario: Expected behavior
Given [initial context/state]
When [action is taken]
Then [expected outcome]
```
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Provide steps to reproduce the bug
placeholder: |
1. Go to '...'
2. Run command '...'
3. See error
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Provide relevant environment details
placeholder: |
- OS: [e.g., Ubuntu 24.04, macOS 14.0]
- Version: [e.g., v0.5.0]
- Rust version: [e.g., 1.75.0]
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any additional information, logs, or screenshots
placeholder: Add any other context, error logs, or screenshots here.
validations:
required: false

94
.github/ISSUE_TEMPLATE/epic.yml vendored Normal file
View File

@@ -0,0 +1,94 @@
name: Epic
description: Define a large body of work spanning multiple features
labels: ["epic"]
type: "Epic"
body:
- type: markdown
attributes:
value: |
Thanks for creating an epic!
- type: textarea
id: description
attributes:
label: Description
description: Describe the epic and its business value
placeholder: |
In order to [achieve major goal/strategic benefit],
as [stakeholder/user type],
we need [high-level capability or outcome].
**Business Value:**
[Why is this important? What problem does it solve?]
validations:
required: true
- type: textarea
id: scope
attributes:
label: Scope
description: High-level scope and boundaries of this epic
placeholder: |
**In Scope:**
- [What's included]
- [Major capabilities]
**Out of Scope:**
- [What's explicitly excluded]
- [Future considerations]
validations:
required: true
- type: textarea
id: success-criteria
attributes:
label: Success Criteria
description: How will we know this epic is successful?
placeholder: |
```gherkin
Scenario: Epic is complete
Given [all features are implemented]
When [users interact with the system]
Then [desired outcomes are achieved]
```
**Metrics:**
- [Measurable success metric 1]
- [Measurable success metric 2]
validations:
required: true
- type: textarea
id: features
attributes:
label: Features & Tasks
description: List of features or tasks that make up this epic
placeholder: |
- [ ] #[issue-number] - [Feature/Task name]
- [ ] #[issue-number] - [Feature/Task name]
- [ ] #[issue-number] - [Feature/Task name]
validations:
required: false
- type: textarea
id: dependencies
attributes:
label: Dependencies & Risks
description: External dependencies, blockers, or risks
placeholder: |
**Dependencies:**
- [External system/team/resource]
**Risks:**
- [Potential risk or blocker]
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any additional information, mockups, or references
placeholder: Add any other context, diagrams, or references here.
validations:
required: false

50
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@@ -0,0 +1,50 @@
name: Feature
description: Request a new feature or enhancement
labels: ["enhancement"]
type: "Feature"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a feature!
- type: textarea
id: description
attributes:
label: Description
description: Describe the feature using the "In order to" format
placeholder: |
In order to [achieve some goal/benefit],
as a [type of user],
I want [some feature/capability].
validations:
required: true
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: Define the acceptance criteria using Given/When/Then format
placeholder: |
```gherkin
Scenario: [Scenario name]
Given [initial context/state]
When [action is taken]
Then [expected outcome]
Scenario: [Another scenario name]
Given [initial context/state]
When [action is taken]
Then [expected outcome]
```
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any additional information, mockups, or references
placeholder: Add any other context, screenshots, or references here.
validations:
required: false

92
.github/ISSUE_TEMPLATE/support.yml vendored Normal file
View File

@@ -0,0 +1,92 @@
name: Support Request
description: Get help with using the application or troubleshooting issues
labels: ["support"]
type: "Support"
body:
- type: markdown
attributes:
value: |
Thanks for reaching out! We'll help you as soon as possible.
- type: textarea
id: description
attributes:
label: Description
description: Describe what you're trying to do and what help you need
placeholder: |
In order to [achieve some goal],
as a [type of user],
I need help with [specific issue or question].
validations:
required: true
- type: textarea
id: current-situation
attributes:
label: Current Situation
description: What's happening now or what you've already tried
placeholder: |
```gherkin
Scenario: Current situation
Given [what I have/where I am]
When [what I do/try]
Then [what happens]
```
**What I've tried:**
- [Thing 1]
- [Thing 2]
validations:
required: true
- type: textarea
id: expected-outcome
attributes:
label: Expected Outcome
description: What are you trying to accomplish?
placeholder: |
```gherkin
Scenario: What I'm trying to achieve
Given [starting point]
When [action I want to take]
Then [desired result]
```
validations:
required: true
- type: dropdown
id: priority
attributes:
label: Priority
description: How urgent is this issue?
options:
- Low - I can work around this
- Medium - This is blocking some work
- High - This is blocking critical work
- Critical - System is down or unusable
default: 0
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: System information that might be relevant
placeholder: |
- OS: [e.g., Ubuntu 24.04, macOS 14.0, Windows 11]
- Version: [e.g., v0.5.0]
- Browser: [if web-based]
- Other relevant details: [e.g., network setup, deployment environment]
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Logs, screenshots, error messages, or other helpful information
placeholder: |
Add any error messages, logs, screenshots, or other context here.
validations:
required: false

57
.github/ISSUE_TEMPLATE/task.yml vendored Normal file
View File

@@ -0,0 +1,57 @@
name: Task
description: Create a work item or implementation task
labels: ["task"]
type: "Task"
body:
- type: markdown
attributes:
value: |
Thanks for creating a task!
- type: textarea
id: description
attributes:
label: Description
description: Describe what needs to be done
placeholder: |
In order to [achieve some goal/benefit],
as a [type of user/developer],
I need [specific work to be completed].
validations:
required: true
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: Define when this task is complete using Given/When/Then format
placeholder: |
```gherkin
Scenario: Task is complete
Given [initial state]
When [implementation is done]
Then [expected result]
```
validations:
required: true
- type: textarea
id: technical-notes
attributes:
label: Technical Notes
description: Implementation details, dependencies, or technical considerations
placeholder: |
- Dependencies: [any prerequisites or blocking issues]
- Approach: [high-level implementation approach]
- Files affected: [key files or modules to change]
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any additional information or references
placeholder: Add any other context here.
validations:
required: false