Skip to content

Commit fe60e53

Browse files
danielsreichenbachdanielsreichenbach
authored
Merge pull request #1 from wowemulation-dev/doc/github-templates
docs: add issue and pull request template
2 parents afbbdc8 + 855505b commit fe60e53

File tree

7 files changed

+1099
-0
lines changed

7 files changed

+1099
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
Please provide as much information as possible to help us reproduce and fix the issue.
11+
12+
- type: checkboxes
13+
id: prerequisites
14+
attributes:
15+
label: Prerequisites
16+
description: Please confirm you have completed the following
17+
options:
18+
- label: I have searched existing issues to ensure this isn't a duplicate
19+
required: true
20+
- label: I have read the [Contributing Guidelines](../CONTRIBUTING.md)
21+
required: true
22+
- label: I am using the latest version or main branch
23+
required: false
24+
25+
- type: textarea
26+
id: bug-description
27+
attributes:
28+
label: Bug Description
29+
description: A clear and concise description of what the bug is
30+
placeholder: Describe what happened...
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: expected-behavior
36+
attributes:
37+
label: Expected Behavior
38+
description: What you expected to happen
39+
placeholder: Describe what you expected...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: actual-behavior
45+
attributes:
46+
label: Actual Behavior
47+
description: What actually happened
48+
placeholder: Describe what actually happened...
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: steps-to-reproduce
54+
attributes:
55+
label: Steps to Reproduce
56+
description: Steps to reproduce the behavior
57+
placeholder: |
58+
1. Run command `...`
59+
2. With input file `...`
60+
3. See error...
61+
validations:
62+
required: true
63+
64+
- type: input
65+
id: version
66+
attributes:
67+
label: Version
68+
description: What version of warcraft-rs are you using?
69+
placeholder: "v0.1.0 or commit hash"
70+
validations:
71+
required: true
72+
73+
- type: dropdown
74+
id: operating-system
75+
attributes:
76+
label: Operating System
77+
description: What operating system are you using?
78+
options:
79+
- Linux
80+
- macOS
81+
- Windows
82+
- Other (please specify in additional context)
83+
validations:
84+
required: true
85+
86+
- type: input
87+
id: rust-version
88+
attributes:
89+
label: Rust Version
90+
description: What version of Rust are you using? (Run `rustc --version`)
91+
placeholder: "rustc 1.86.0"
92+
validations:
93+
required: false
94+
95+
- type: textarea
96+
id: command-output
97+
attributes:
98+
label: Command Output
99+
description: Please paste the full command output, including any error messages
100+
render: shell
101+
placeholder: |
102+
$ cargo run -- mpq list example.mpq
103+
Error: Failed to open archive
104+
...
105+
validations:
106+
required: false
107+
108+
- type: textarea
109+
id: file-details
110+
attributes:
111+
label: File Details
112+
description: If the issue is with a specific file, please provide details
113+
placeholder: |
114+
- File type: MPQ/DBC/BLP/etc.
115+
- File size:
116+
- WoW version: 1.12.1/2.4.3/3.3.5a/etc.
117+
- Source: Original Blizzard files/modified/etc.
118+
validations:
119+
required: false
120+
121+
- type: textarea
122+
id: logs
123+
attributes:
124+
label: Logs
125+
description: Please paste any relevant log output (use `RUST_LOG=debug` for verbose logs)
126+
render: shell
127+
placeholder: |
128+
Set RUST_LOG=debug and paste output here...
129+
validations:
130+
required: false
131+
132+
- type: textarea
133+
id: additional-context
134+
attributes:
135+
label: Additional Context
136+
description: Any other context about the problem
137+
placeholder: |
138+
- Does this happen with all files or just specific ones?
139+
- Any workarounds you've found?
140+
- Related issues or discussions?
141+
validations:
142+
required: false
143+
144+
- type: checkboxes
145+
id: component
146+
attributes:
147+
label: Affected Components
148+
description: Which components are affected? (Check all that apply)
149+
options:
150+
- label: MPQ archives
151+
- label: DBC/DB2 databases
152+
- label: BLP textures
153+
- label: M2 models
154+
- label: WMO world objects
155+
- label: ADT terrain
156+
- label: WDT/WDL world data
157+
- label: CLI interface
158+
- label: FFI/C bindings
159+
- label: Documentation
160+
- label: Build system

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📚 Documentation
4+
url: https://github.com/wowemulation-dev/warcraft-rs/tree/main/docs
5+
about: Check our comprehensive documentation for guides and API references
6+
- name: 💬 Discussions
7+
url: https://github.com/orgs/wowemulation-dev/discussions
8+
about: Ask questions, share ideas, and discuss with the community
9+
- name: 🚀 Project Status
10+
url: https://github.com/wowemulation-dev/warcraft-rs/blob/main/README.md#project-status
11+
about: Check current implementation status and roadmap
12+
- name: 🔒 Security Policy
13+
url: https://github.com/wowemulation-dev/.github/blob/main/SECURITY.md
14+
about: Review our security policy and responsible disclosure process

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
name: 📚 Documentation Issue
2+
description: Report missing, incorrect, or unclear documentation
3+
title: "[Docs]: "
4+
labels: ["documentation", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation!
10+
Clear and accurate documentation is essential for a good developer experience.
11+
12+
- type: checkboxes
13+
id: prerequisites
14+
attributes:
15+
label: Prerequisites
16+
description: Please confirm you have completed the following
17+
options:
18+
- label: I have searched existing issues to ensure this isn't a duplicate
19+
required: true
20+
- label: I have checked the latest documentation on the main branch
21+
required: true
22+
23+
- type: dropdown
24+
id: documentation-type
25+
attributes:
26+
label: Documentation Type
27+
description: What type of documentation issue is this?
28+
options:
29+
- Missing documentation
30+
- Incorrect/outdated information
31+
- Unclear explanation
32+
- Broken links
33+
- Formatting issues
34+
- Code examples not working
35+
- API documentation gaps
36+
- Tutorial improvements
37+
- Installation guide issues
38+
- Other
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: issue-description
44+
attributes:
45+
label: Issue Description
46+
description: Describe the documentation problem
47+
placeholder: |
48+
What's wrong with the current documentation?
49+
What information is missing or unclear?
50+
validations:
51+
required: true
52+
53+
- type: input
54+
id: documentation-location
55+
attributes:
56+
label: Documentation Location
57+
description: Where is the problematic documentation located?
58+
placeholder: |
59+
e.g., docs/guides/mpq-archives.md, README.md, API docs for Archive::open, etc.
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: current-content
65+
attributes:
66+
label: Current Content
67+
description: Quote the current documentation content (if applicable)
68+
render: markdown
69+
placeholder: |
70+
```markdown
71+
Current documentation that needs improvement...
72+
```
73+
validations:
74+
required: false
75+
76+
- type: textarea
77+
id: suggested-improvement
78+
attributes:
79+
label: Suggested Improvement
80+
description: How should the documentation be improved?
81+
placeholder: |
82+
- What information should be added?
83+
- How should existing content be clarified?
84+
- What examples would be helpful?
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: user-scenario
90+
attributes:
91+
label: User Scenario
92+
description: When would someone need this documentation?
93+
placeholder: |
94+
Describe the user journey or use case...
95+
- What is the user trying to accomplish?
96+
- What level of experience do they have?
97+
- What context are they coming from?
98+
validations:
99+
required: false
100+
101+
- type: checkboxes
102+
id: affected-sections
103+
attributes:
104+
label: Affected Documentation Sections
105+
description: Which documentation sections are affected? (Check all that apply)
106+
options:
107+
- label: README.md
108+
- label: Getting Started guides
109+
- label: Installation instructions
110+
- label: CLI usage guides
111+
- label: API documentation (rustdoc)
112+
- label: Format-specific guides (MPQ, DBC, etc.)
113+
- label: Architecture documentation
114+
- label: Contributing guidelines
115+
- label: Code examples
116+
- label: Tutorial content
117+
- label: Troubleshooting guides
118+
- label: Performance guides
119+
120+
- type: dropdown
121+
id: audience
122+
attributes:
123+
label: Target Audience
124+
description: Who is the primary audience for this documentation?
125+
options:
126+
- Beginners/new users
127+
- Intermediate developers
128+
- Advanced users
129+
- Contributors/maintainers
130+
- Library users (API consumers)
131+
- CLI users
132+
- All audiences
133+
- Other
134+
validations:
135+
required: false
136+
137+
- type: textarea
138+
id: examples-needed
139+
attributes:
140+
label: Examples Needed
141+
description: What examples would make this clearer?
142+
placeholder: |
143+
- Code examples
144+
- Command-line examples
145+
- Screenshots
146+
- Diagrams
147+
- Step-by-step tutorials
148+
validations:
149+
required: false
150+
151+
- type: textarea
152+
id: related-content
153+
attributes:
154+
label: Related Content
155+
description: Links to related documentation or resources
156+
placeholder: |
157+
- Similar documentation that works well
158+
- External resources that could be referenced
159+
- Related issues or discussions
160+
validations:
161+
required: false
162+
163+
- type: checkboxes
164+
id: contribution-willingness
165+
attributes:
166+
label: Contribution
167+
description: Are you willing to help improve this documentation?
168+
options:
169+
- label: I can write the improved documentation
170+
- label: I can provide examples or code snippets
171+
- label: I can review proposed changes
172+
- label: I can test documentation changes
173+
- label: I'm looking for someone else to fix this
174+
175+
- type: textarea
176+
id: additional-context
177+
attributes:
178+
label: Additional Context
179+
description: Any other information that would help improve the documentation
180+
placeholder: |
181+
- Common misconceptions users have
182+
- Frequently asked questions
183+
- Error messages users encounter
184+
- Related tools or workflows
185+
validations:
186+
required: false

0 commit comments

Comments
 (0)