Skip to content

Commit 268d47c

Browse files
X-T-E-RX-T-E-R
committed
Add GitHub issue and PR templates
1 parent f5257bb commit 268d47c

7 files changed

Lines changed: 335 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Bug report
2+
description: Report something that is not working as expected.
3+
title: "[Bug]: "
4+
labels: ["bug", "status: needs triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve OpenPet. English or Chinese are both welcome.
10+
- type: checkboxes
11+
id: existing
12+
attributes:
13+
label: Existing issues
14+
description: Please search before opening a new issue.
15+
options:
16+
- label: I have searched existing issues and did not find a duplicate.
17+
required: true
18+
- type: textarea
19+
id: current-behavior
20+
attributes:
21+
label: Current behavior
22+
description: What happened?
23+
placeholder: Describe the bug and what you saw.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: expected-behavior
28+
attributes:
29+
label: Expected behavior
30+
description: What did you expect to happen?
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: steps
35+
attributes:
36+
label: Steps to reproduce
37+
description: Give the smallest set of steps that reproduces the problem.
38+
placeholder: |
39+
1. Start OpenPet...
40+
2. Open Settings...
41+
3. See...
42+
validations:
43+
required: true
44+
- type: dropdown
45+
id: platform
46+
attributes:
47+
label: Platform
48+
multiple: true
49+
options:
50+
- Windows
51+
- macOS
52+
- Linux
53+
- Other
54+
validations:
55+
required: true
56+
- type: input
57+
id: version
58+
attributes:
59+
label: OpenPet version
60+
placeholder: "v0.1.2, main branch commit, or unknown"
61+
validations:
62+
required: false
63+
- type: textarea
64+
id: logs
65+
attributes:
66+
label: Logs or screenshots
67+
description: Paste relevant logs or drag screenshots here if they help explain the issue.
68+
render: shell
69+
validations:
70+
required: false
71+
- type: textarea
72+
id: extra-context
73+
attributes:
74+
label: Additional context
75+
description: Anything else that may help us investigate.
76+
validations:
77+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Feature request
2+
description: Suggest an improvement or new capability for OpenPet.
3+
title: "[Feature]: "
4+
labels: ["enhancement", "status: needs triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for sharing an idea. English or Chinese are both welcome.
10+
- type: checkboxes
11+
id: existing
12+
attributes:
13+
label: Existing issues
14+
description: Please search before opening a new request.
15+
options:
16+
- label: I have searched existing issues and did not find a duplicate.
17+
required: true
18+
- type: textarea
19+
id: problem
20+
attributes:
21+
label: Problem or use case
22+
description: What are you trying to do, and why is the current behavior not enough?
23+
placeholder: I want OpenPet to...
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: proposal
28+
attributes:
29+
label: Proposed solution
30+
description: What would a good solution look like?
31+
validations:
32+
required: true
33+
- type: dropdown
34+
id: area
35+
attributes:
36+
label: Area
37+
multiple: true
38+
options:
39+
- Pet runtime
40+
- Settings UI
41+
- Pet import
42+
- CLI or MCP
43+
- Release or packaging
44+
- Documentation
45+
- Other
46+
validations:
47+
required: false
48+
- type: textarea
49+
id: alternatives
50+
attributes:
51+
label: Alternatives considered
52+
description: If you already tried or considered another approach, describe it here.
53+
validations:
54+
required: false
55+
- type: textarea
56+
id: extra-context
57+
attributes:
58+
label: Additional context
59+
description: Links, screenshots, mockups, or related tools.
60+
validations:
61+
required: false

‎.github/ISSUE_TEMPLATE/pet_import_compatibility.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Pet import compatibility
2+
description: Report a website or pet package that OpenPet cannot import correctly.
3+
title: "[Import]: "
4+
labels: ["bug", "area: import", "status: needs triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this when an import source or Codex-compatible pet package fails. English or Chinese are both welcome.
10+
- type: checkboxes
11+
id: existing
12+
attributes:
13+
label: Existing issues
14+
options:
15+
- label: I have searched existing issues and did not find a duplicate.
16+
required: true
17+
- type: input
18+
id: source-url
19+
attributes:
20+
label: Source URL or package path
21+
description: Paste the public pet page URL, share URL, or describe the local package.
22+
placeholder: "https://petdex.crafter.run/pets/..."
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: failure
27+
attributes:
28+
label: What failed?
29+
description: Describe the error, missing asset, wrong animation, or unexpected result.
30+
validations:
31+
required: true
32+
- type: dropdown
33+
id: source-type
34+
attributes:
35+
label: Source type
36+
options:
37+
- Petdex
38+
- Codex Pets
39+
- SpriteYard
40+
- Codex Pet Shop
41+
- Local package
42+
- Other website
43+
validations:
44+
required: false
45+
- type: textarea
46+
id: logs
47+
attributes:
48+
label: Logs or screenshots
49+
description: Paste import logs or screenshots if available.
50+
render: shell
51+
validations:
52+
required: false
53+
- type: input
54+
id: version
55+
attributes:
56+
label: OpenPet version
57+
placeholder: "v0.1.2, main branch commit, or unknown"
58+
validations:
59+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Question
2+
description: Ask a usage or integration question.
3+
title: "[Question]: "
4+
labels: ["question", "status: needs info"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
English or Chinese are both welcome.
10+
- type: textarea
11+
id: question
12+
attributes:
13+
label: Question
14+
description: What would you like to know?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: context
19+
attributes:
20+
label: Context
21+
description: Tell us what you are building, what you tried, or which agent/tool you are integrating.
22+
validations:
23+
required: false

‎.github/labels.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Repository label taxonomy for OpenPet.
2+
#
3+
# GitHub does not sync this file automatically. It documents the intended label
4+
# set and can be applied with `gh label create --force`.
5+
6+
- name: bug
7+
color: d73a4a
8+
description: Something is not working as expected.
9+
- name: documentation
10+
color: 0075ca
11+
description: Improvements or additions to documentation.
12+
- name: duplicate
13+
color: cfd3d7
14+
description: This issue or pull request already exists.
15+
- name: enhancement
16+
color: a2eeef
17+
description: New feature or request.
18+
- name: good first issue
19+
color: 7057ff
20+
description: Good for newcomers.
21+
- name: help wanted
22+
color: 008672
23+
description: Extra attention is needed.
24+
- name: invalid
25+
color: e4e669
26+
description: This is not valid or no longer relevant.
27+
- name: question
28+
color: d876e3
29+
description: Usage or integration question.
30+
- name: wontfix
31+
color: ffffff
32+
description: This will not be worked on.
33+
- name: dependencies
34+
color: 0366d6
35+
description: Dependency updates or dependency-related issues.
36+
- name: "area: runtime"
37+
color: 1d76db
38+
description: Desktop pet runtime, window behavior, tray, or local API.
39+
- name: "area: ui"
40+
color: c5def5
41+
description: React UI, settings, visual layout, or interaction changes.
42+
- name: "area: import"
43+
color: bfd4f2
44+
description: Pet import, website compatibility, or catalog behavior.
45+
- name: "area: cli-mcp"
46+
color: 5319e7
47+
description: Agent CLI, MCP bridge, or automation integration.
48+
- name: "area: release"
49+
color: 0e8a16
50+
description: CI, packaging, signing, updater, or release distribution.
51+
- name: "area: docs"
52+
color: 0075ca
53+
description: README, guides, examples, or project documentation.
54+
- name: "platform: windows"
55+
color: 0052cc
56+
description: Windows-specific behavior or packaging.
57+
- name: "platform: macos"
58+
color: 5319e7
59+
description: macOS-specific behavior or packaging.
60+
- name: "platform: linux"
61+
color: f9d0c4
62+
description: Linux-specific behavior or packaging.
63+
- name: "priority: high"
64+
color: b60205
65+
description: Important issue that should be handled soon.
66+
- name: "priority: normal"
67+
color: fbca04
68+
description: Normal priority work.
69+
- name: "priority: low"
70+
color: 0e8a16
71+
description: Nice-to-have or low urgency work.
72+
- name: "status: needs triage"
73+
color: ededed
74+
description: New issue or PR awaiting maintainer triage.
75+
- name: "status: needs info"
76+
color: d4c5f9
77+
description: Waiting for more information from the author.
78+
- name: "status: blocked"
79+
color: 000000
80+
description: Blocked by an external dependency or unresolved decision.
81+
- name: "status: ready to merge"
82+
color: 0e8a16
83+
description: Reviewed and ready to merge.

‎.github/pull_request_template.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Summary
2+
3+
<!-- What does this PR change? Keep it short and concrete. -->
4+
5+
## Type
6+
7+
- [ ] Bug fix
8+
- [ ] Feature / enhancement
9+
- [ ] Documentation
10+
- [ ] Refactor / maintenance
11+
- [ ] Release / CI
12+
13+
## Validation
14+
15+
<!-- Mark commands you ran. Add screenshots or logs for UI/runtime behavior when useful. -->
16+
17+
- [ ] `pnpm build`
18+
- [ ] `cargo check --manifest-path src-tauri/Cargo.toml`
19+
- [ ] Manual runtime check
20+
- [ ] Not run; reason:
21+
22+
## Platform Impact
23+
24+
- [ ] Windows
25+
- [ ] macOS
26+
- [ ] Linux
27+
- [ ] Cross-platform / not platform-specific
28+
29+
## Notes For Reviewers
30+
31+
<!-- Risks, follow-up work, screenshots, or anything reviewers should focus on. -->

0 commit comments

Comments
 (0)