Skip to content

Commit 86db4b3

Browse files
ulises-jeremiasulises-jeremias
authored
docs: improve public issue templates (#66)
* docs: improve public issue templates * style: normalize issue template yaml * style: resolve issue template lint * docs: align issue templates with public style * docs: clarify log redaction guidance * docs: fix issue form schema lint * ci: fix danger pnpm setup
1 parent f48cd20 commit 86db4b3

8 files changed

Lines changed: 421 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "[BUG]: short issue description"
5+
labels: [bug]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report 🤗
11+
Make sure there aren't any open/closed issues for this topic 😃
12+
Please fill out the sections below to help us understand the issue.
13+
14+
- type: checkboxes
15+
id: search
16+
attributes:
17+
label: Is there an existing issue for this?
18+
description: Please search to see if an issue already exists.
19+
options:
20+
- label: I have searched the existing issues
21+
required: true
22+
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Describe the bug
27+
description: What is the problem? A clear and concise bug description.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: Expected Behavior
35+
description: |
36+
What did you expect to happen?
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: current
42+
attributes:
43+
label: Current Behavior
44+
description: |
45+
What actually happened?
46+
47+
Please include relevant errors, exceptions, stack traces, and logs.
48+
Redact secrets, tokens, credentials, private URLs, account IDs, and
49+
any personal or customer data before posting.
50+
51+
If wire logs are relevant, share only sanitized excerpts.
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: reproduction
57+
attributes:
58+
label: Reproduction Steps
59+
description: |
60+
Provide a self-contained, concise snippet of code that can be used to
61+
reproduce the issue. For more complex issues provide a repo with the
62+
smallest sample that reproduces the bug.
63+
64+
Avoid including business logic or unrelated code, it makes diagnosis
65+
more difficult. The code sample should be a small reproducible
66+
example.
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: solution
72+
attributes:
73+
label: Possible Solution
74+
description: |
75+
Suggest a fix/reason for the bug
76+
validations:
77+
required: false
78+
79+
- type: textarea
80+
id: context
81+
attributes:
82+
label: Additional Information/Context
83+
description: |
84+
Anything else that might be relevant for troubleshooting this bug.
85+
Providing context helps us come up with a solution that is most useful
86+
in the real world.
87+
validations:
88+
required: false
89+
90+
- type: input
91+
id: version
92+
attributes:
93+
label: Version used
94+
description: |
95+
Please provide the version of the repository or tool you are using.
96+
validations:
97+
required: true
98+
99+
- type: textarea
100+
id: environment
101+
attributes:
102+
label: Environment details (OS name and version, etc.)
103+
placeholder: |
104+
- OS:
105+
- Runtime/tool version:
106+
- Package manager:
107+
validations:
108+
required: true
109+
110+
- type: textarea
111+
id: logs
112+
attributes:
113+
label: Relevant log output
114+
description: Copy and paste any relevant log output.
115+
render: shell
116+
validations:
117+
required: false
118+
119+
- type: checkboxes
120+
id: public-safety
121+
attributes:
122+
label: Public issue checklist
123+
options:
124+
- label: This issue does not include secrets or private project links
125+
required: true
126+
127+
- type: checkboxes
128+
id: contribution
129+
attributes:
130+
label: Contribution
131+
options:
132+
- label: I may be able to submit a pull request for this bug
133+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: GitHub organization
5+
url: https://github.com/nanlabs
6+
about: For public information about open source repositories.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: "📕 Documentation Issue"
3+
description: Report an issue in the Reference documentation or Developer Guide
4+
title: "(short issue description)"
5+
labels: [documentation]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for helping us improve our documentation 📚
11+
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Describe the issue
16+
description: A clear and concise description of the issue.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: links
22+
attributes:
23+
label: Links
24+
description: |
25+
Include links to affected documentation page(s).
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: suggestion
31+
attributes:
32+
label: Suggested Content
33+
description: If you have a draft, outline, or examples, share them here.
34+
validations:
35+
required: false
36+
37+
- type: textarea
38+
id: validation
39+
attributes:
40+
label: Validation
41+
description: How should the documentation change be checked?
42+
value: |
43+
- [ ] Verify all links resolve
44+
- [ ] Run markdown lint checks if available
45+
validations:
46+
required: false
47+
48+
- type: checkboxes
49+
id: ack
50+
attributes:
51+
label: Acknowledgements
52+
options:
53+
- label: I may be able to submit a pull request for this documentation
54+
required: false
55+
- label: This issue does not include secrets or private project links
56+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(short issue description)"
5+
labels: [feature-request, enhancement]
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Describe the feature
11+
description: A clear and concise description of the proposed feature.
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature?
21+
For example: "I'm always frustrated when..."
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: solution
27+
attributes:
28+
label: Proposed Solution
29+
description: |
30+
Suggest how to implement the addition or change. Please include a
31+
prototype, workaround, sketch, or reference implementation.
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: acceptance-criteria
37+
attributes:
38+
label: Acceptance Criteria
39+
description: How will maintainers know this is complete?
40+
value: |
41+
- [ ] Add the expected behavior
42+
- [ ] Update tests or docs when applicable
43+
- [ ] Document validation steps
44+
validations:
45+
required: false
46+
47+
- type: textarea
48+
id: other
49+
attributes:
50+
label: Other Information
51+
description: |
52+
Any alternative solutions or features you considered, a more detailed
53+
explanation, stack traces, related issues, links for context, etc.
54+
validations:
55+
required: false
56+
57+
- type: checkboxes
58+
id: ack
59+
attributes:
60+
label: Acknowledgements
61+
options:
62+
- label: I may be able to implement this feature request
63+
required: false
64+
- label: This feature might incur a breaking change
65+
required: false
66+
67+
- type: input
68+
id: version
69+
attributes:
70+
label: Version used
71+
description: |
72+
Please provide the version of the repository or tool you are using.
73+
validations:
74+
required: true
75+
76+
- type: input
77+
id: environment
78+
attributes:
79+
label: Environment details (OS name and version, etc.)
80+
validations:
81+
required: true
82+
83+
- type: checkboxes
84+
id: public-safety
85+
attributes:
86+
label: Public issue checklist
87+
options:
88+
- label: This request does not include secrets or private project links
89+
required: true

‎.github/ISSUE_TEMPLATE/good-first-issue.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: "🌱 Good First Issue"
3+
description: Propose a well-scoped task for new contributors
4+
title: "[GOOD FIRST ISSUE]: short issue description"
5+
labels: [good first issue, help wanted]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this template to propose small, well-scoped tasks that help new
11+
contributors get started.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Describe the task
17+
description: A clear and concise description of what should be done.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: context
23+
attributes:
24+
label: Context
25+
description: Why is this useful for the project and for contributors?
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: scope
31+
attributes:
32+
label: Scope
33+
description: Keep this small and explicit.
34+
value: |
35+
- Add or update one focused area
36+
- Keep the change local to the documented scope
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: files
42+
attributes:
43+
label: Suggested files or areas
44+
description: Point contributors to likely starting points.
45+
placeholder: README.md, docs/..., examples/..., packages/...
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
id: validation
51+
attributes:
52+
label: Validation
53+
description: Commands or manual checks a contributor can run locally.
54+
value: |
55+
- [ ] Run the documented local check
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: out-of-scope
61+
attributes:
62+
label: Out of Scope
63+
description: What should contributors avoid changing?
64+
validations:
65+
required: false
66+
67+
- type: checkboxes
68+
id: contributor-ready
69+
attributes:
70+
label: Contributor Readiness
71+
options:
72+
- label: This task does not require private credentials or systems
73+
required: true
74+
- label: This task has a clear validation path
75+
required: true
76+
- label: This task is small enough for a first contribution
77+
required: true

0 commit comments

Comments
 (0)