-
Notifications
You must be signed in to change notification settings - Fork 1
chore: GitHub templates (bug/feature/task/PR/RFC) #92
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
2060d08
chore: add issue/PR/RFC templates and link RFCs to Discussions
flyingrobots 9bb51fe
chore(templates): remove trailing blank lines from YAML templates to …
flyingrobots 1adf432
Merge branch 'main' into echo/pr-templates-and-project
flyingrobots dacf62b
chore(templates): quote task parent placeholder and remove trailing b…
flyingrobots 3e6b480
Merge branch 'echo/pr-templates-and-project' of github.com:flyingrobo…
flyingrobots 47db6e7
docs: note templates + project board changes in execution plan and de…
flyingrobots cdcba2e
chore(templates): scope PR to templates only; remove unrelated files;…
flyingrobots cd1e26c
chore(templates): add optional 'stack_trace' and 'version' fields to …
flyingrobots File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| title: "RFC: <title>" | ||
| labels: [] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Use this template to propose a change. Keep it concise and focused. | ||
| - type: textarea | ||
| id: summary | ||
| attributes: | ||
| label: Summary | ||
| description: One paragraph overview of the proposal | ||
| - type: textarea | ||
| id: motivation | ||
| attributes: | ||
| label: Motivation / Problem Statement | ||
| - type: textarea | ||
| id: design | ||
| attributes: | ||
| label: Proposed Design | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives Considered | ||
| - type: textarea | ||
| id: impact | ||
| attributes: | ||
| label: Risks / Impact | ||
| - type: textarea | ||
| id: rollout | ||
| attributes: | ||
| label: Rollout Plan |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| name: Bug Report | ||
| description: Report a runtime or tooling bug | ||
| title: "bug: <short description>" | ||
| labels: [bug] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for filing a bug. Please include clear steps to reproduce and expected vs actual behavior. | ||
| - type: input | ||
| id: area | ||
| attributes: | ||
| label: Area | ||
| description: Subsystem impacted (runtime, ffi, wasm, geom, cli, docs) | ||
| placeholder: e.g., runtime/snapshot | ||
| - type: textarea | ||
| id: repro | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: Provide a minimal reproduction (code, commands, inputs) | ||
| placeholder: | | ||
| 1. ... | ||
| 2. ... | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected Behavior | ||
| - type: textarea | ||
| id: actual | ||
| attributes: | ||
| label: Actual Behavior | ||
| - type: textarea | ||
| id: stack_trace | ||
| attributes: | ||
| label: Stack Trace / Error Logs | ||
| description: paste full stack trace or logs | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Version / Commit | ||
| description: git SHA or package version | ||
| - type: checkboxes | ||
| id: env | ||
| attributes: | ||
| label: Environment | ||
| options: | ||
| - label: Linux (glibc) | ||
| - label: Linux (musl) | ||
| - label: macOS (local) | ||
| - label: Other | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: RFC (open a discussion) | ||
| url: https://github.com/flyingrobots/echo/discussions/new?category=ideas | ||
| about: Propose an RFC via Discussions (Ideas category) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: Feature | ||
| description: Propose a new feature (umbrella) | ||
| title: "feat: <short description>" | ||
| labels: [feature] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Describe the feature at a high level. Keep implementation details minimal; child tasks will capture the steps. | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Problem / Motivation | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposal / Scope | ||
| description: Boundaries, non-goals, and acceptance criteria | ||
| - type: textarea | ||
| id: links | ||
| attributes: | ||
| label: Related Docs/Issues/PRs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| name: Task | ||
| description: Small, bite-sized task (1–3 hours, max 5 per feature) | ||
| title: "task: <short description>" | ||
| labels: [task] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Tasks should be specific and testable. Link to the parent feature issue in the description. | ||
| - type: input | ||
| id: parent | ||
| attributes: | ||
| label: Parent Feature Issue | ||
| placeholder: "e.g., #22" | ||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: Steps | ||
| description: Concrete steps to complete this task | ||
| - type: textarea | ||
| id: acceptance | ||
| attributes: | ||
| label: Acceptance Criteria |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| Title: <type(scope): short summary> | ||
|
|
||
| Summary | ||
| - What does this change do in one or two sentences? | ||
|
|
||
| Scope | ||
| - [ ] Tests only | ||
| - [ ] Docs only | ||
| - [ ] Runtime code | ||
|
|
||
| Links | ||
| - Closes #<issue> / Refs #<issue> | ||
|
|
||
| Checklist | ||
| - [ ] Docs Guard satisfied (updated docs/execution-plan.md and docs/decision-log.md when non-doc files changed) | ||
| - [ ] CI green (fmt, clippy, tests, rustdoc, audit/deny) | ||
| - [ ] Kept PR small and focused (one thing) | ||
|
|
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.