docs: add issue templates
This commit is contained in:
parent
8a50d2ef3e
commit
0692d5722c
67
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
67
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,67 @@
|
||||
name: Bug report
|
||||
description: Report a reproducible product, API, or operations bug.
|
||||
title: "[Bug]: "
|
||||
labels: ["bug", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for helping improve yedir-ai.
|
||||
|
||||
Do not include secrets, cookies, Authorization headers, OAuth codes, signed URLs, `.env.local` values, private prompts, base64 data, or private user content. If this is a security issue, do not open a public issue. Follow `SECURITY.md` instead.
|
||||
|
||||
- type: textarea
|
||||
id: summary
|
||||
attributes:
|
||||
label: Summary
|
||||
description: What happened, and what did you expect instead?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Reproduction steps
|
||||
description: Provide the smallest reliable reproduction.
|
||||
placeholder: |
|
||||
1. Go to ...
|
||||
2. Click ...
|
||||
3. Observe ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: impact
|
||||
attributes:
|
||||
label: Impact
|
||||
description: Who is affected and how severe is it?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Browser, OS, deployment target, Node/pnpm versions, or route/API involved.
|
||||
placeholder: |
|
||||
Browser:
|
||||
OS:
|
||||
Node:
|
||||
pnpm:
|
||||
Route/API:
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Sanitized logs or screenshots
|
||||
description: Include only sanitized output. Remove prompts, URLs, tokens, cookies, headers, base64, and private content.
|
||||
|
||||
- type: checkboxes
|
||||
id: checks
|
||||
attributes:
|
||||
label: Pre-submit checklist
|
||||
options:
|
||||
- label: I removed secrets, tokens, signed URLs, cookies, private prompts, and private user content.
|
||||
required: true
|
||||
- label: I searched existing issues and docs before filing this.
|
||||
required: true
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Security vulnerability
|
||||
url: https://github.com/lanmu1818-ship-it/ai-chatbot/blob/main/SECURITY.md
|
||||
about: Do not open public issues for vulnerabilities. Follow SECURITY.md and report privately to the project maintainer.
|
||||
- name: Release readiness and contribution rules
|
||||
url: https://github.com/lanmu1818-ship-it/ai-chatbot/blob/main/CONTRIBUTING.md
|
||||
about: Read docs/release-readiness.md and CONTRIBUTING.md before opening broad engineering requests.
|
||||
68
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
68
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,68 @@
|
||||
name: Feature request
|
||||
description: Propose a product, workflow, integration, or engineering improvement.
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Please keep proposals focused and avoid sharing private customer data, prompts, screenshots with secrets, or provider credentials.
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: Problem or opportunity
|
||||
description: What user, operator, or developer problem does this solve?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
description: Describe the behavior, API, UI, or documentation change.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Area
|
||||
options:
|
||||
- Lovart home
|
||||
- Canvas / Agent
|
||||
- Image or video generation
|
||||
- 3D / CAD
|
||||
- Settings / admin
|
||||
- API / backend
|
||||
- Performance
|
||||
- Security / observability
|
||||
- Documentation / CI
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives considered
|
||||
description: What other approaches did you consider?
|
||||
|
||||
- type: textarea
|
||||
id: acceptance
|
||||
attributes:
|
||||
label: Acceptance criteria
|
||||
description: How should reviewers verify that this is done?
|
||||
placeholder: |
|
||||
- ...
|
||||
- ...
|
||||
|
||||
- type: checkboxes
|
||||
id: checks
|
||||
attributes:
|
||||
label: Pre-submit checklist
|
||||
options:
|
||||
- label: This request does not include real secrets, private prompts, signed URLs, or private user data.
|
||||
required: true
|
||||
- label: I checked the README, release readiness notes, and existing issues first.
|
||||
required: true
|
||||
Loading…
x
Reference in New Issue
Block a user