mirror of
https://github.com/Stone-Red-Code/EchoHub.git
synced 2026-09-04 00:56:05 +02:00
feat: Add issue templates for bug reports and feature requests, and update PR template
This commit is contained in:
@@ -0,0 +1,79 @@
|
|||||||
|
name: Bug report
|
||||||
|
description: Report a reproducible bug
|
||||||
|
title: "bug: "
|
||||||
|
labels: [bug]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to report a bug.
|
||||||
|
|
||||||
|
If this is a security issue (auth bypass, token leak, file upload exploit, etc.), please follow SECURITY.md instead of filing a public issue.
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: component
|
||||||
|
attributes:
|
||||||
|
label: Affected component
|
||||||
|
options:
|
||||||
|
- Client (EchoHub.Client)
|
||||||
|
- Server (EchoHub.Server)
|
||||||
|
- Core/shared (EchoHub.Core)
|
||||||
|
- Docs
|
||||||
|
- CI
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: What happened?
|
||||||
|
description: Describe the bug and what you expected to happen.
|
||||||
|
placeholder: "When I..., I expected..., but ..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: repro
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Include minimal, numbered steps.
|
||||||
|
placeholder: |
|
||||||
|
1. ...
|
||||||
|
2. ...
|
||||||
|
3. ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: Logs / stack traces
|
||||||
|
description: Paste relevant logs (redact tokens/secrets).
|
||||||
|
render: text
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: Version
|
||||||
|
description: App version, commit SHA, or release tag.
|
||||||
|
placeholder: v0.1.0
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: environment
|
||||||
|
attributes:
|
||||||
|
label: Environment
|
||||||
|
description: OS, terminal, .NET SDK version.
|
||||||
|
placeholder: |
|
||||||
|
OS: Windows 11
|
||||||
|
Terminal: Windows Terminal
|
||||||
|
.NET SDK: 10.0.x
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
id: confirmations
|
||||||
|
attributes:
|
||||||
|
label: Confirmations
|
||||||
|
options:
|
||||||
|
- label: I searched existing issues and this is not a duplicate
|
||||||
|
required: true
|
||||||
|
- label: I removed sensitive info (tokens/keys) from logs
|
||||||
|
required: true
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Security policy
|
||||||
|
url: https://github.com/HueByte/EchoHub/security/policy
|
||||||
|
about: Please report security vulnerabilities here (or see SECURITY.md).
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
name: Feature request
|
||||||
|
description: Suggest an idea or improvement
|
||||||
|
title: "feat: "
|
||||||
|
labels: [enhancement]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for suggesting an improvement.
|
||||||
|
|
||||||
|
EchoHub tries to stay lightweight: terminal-first, self-hosted, and no upsells.
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: area
|
||||||
|
attributes:
|
||||||
|
label: Area
|
||||||
|
options:
|
||||||
|
- Client (TUI)
|
||||||
|
- Server (API/SignalR)
|
||||||
|
- Auth/security
|
||||||
|
- Files/uploads
|
||||||
|
- Docs
|
||||||
|
- Build/CI
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: problem
|
||||||
|
attributes:
|
||||||
|
label: What problem are you trying to solve?
|
||||||
|
placeholder: "It’s hard to..., because ..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: proposal
|
||||||
|
attributes:
|
||||||
|
label: Proposed solution
|
||||||
|
placeholder: "Add/Change ..., so that ..."
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: Alternatives considered
|
||||||
|
description: Any other approaches you’ve thought about.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: extra
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
description: Mockups, examples, links, etc.
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# Summary
|
||||||
|
|
||||||
|
<!-- What does this PR change, and why? Keep it brief. -->
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Describe the changes here
|
||||||
|
|
||||||
|
## Screenshots / recordings (optional)
|
||||||
|
|
||||||
|
<!-- If you changed the TUI UI/UX, add a screenshot or short recording. -->
|
||||||
|
|
||||||
|
## How to test
|
||||||
|
|
||||||
|
- [ ] `dotnet build src/EchoHub.slnx`
|
||||||
|
- [ ] `dotnet test src/EchoHub.slnx`
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] I ran tests locally (or explained why not)
|
||||||
|
- [ ] I kept changes focused and easy to review
|
||||||
|
- [ ] I updated docs where needed (README/docs)
|
||||||
|
- [ ] I verified no secrets/keys are committed
|
||||||
|
- [ ] If this touches files/uploads/auth, I considered security implications
|
||||||
|
|
||||||
|
## Related issues
|
||||||
|
|
||||||
|
- Closes #
|
||||||
@@ -14,16 +14,8 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Run markdownlint-cli2
|
- name: Run markdownlint
|
||||||
uses: DavidAnson/markdownlint-cli2-action@v19
|
run: bash scripts/lint-markdown.sh
|
||||||
with:
|
|
||||||
globs: |
|
|
||||||
**/*.md
|
|
||||||
!.dev/**
|
|
||||||
!docs/api/**
|
|
||||||
!**/node_modules/**
|
|
||||||
!**/bin/**
|
|
||||||
!**/obj/**
|
|
||||||
|
|
||||||
detect-changes:
|
detect-changes:
|
||||||
name: Detect Changes
|
name: Detect Changes
|
||||||
|
|||||||
@@ -11,16 +11,8 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Run markdownlint-cli2
|
- name: Run markdownlint
|
||||||
uses: DavidAnson/markdownlint-cli2-action@v19
|
run: bash scripts/lint-markdown.sh
|
||||||
with:
|
|
||||||
globs: |
|
|
||||||
**/*.md
|
|
||||||
!.dev/**
|
|
||||||
!docs/api/**
|
|
||||||
!**/node_modules/**
|
|
||||||
!**/bin/**
|
|
||||||
!**/obj/**
|
|
||||||
|
|
||||||
test:
|
test:
|
||||||
name: Build & Test
|
name: Build & Test
|
||||||
|
|||||||
Reference in New Issue
Block a user