Skip to content

Commit dbfd78c

Browse files
authored
chore: add issue templates and improve PR template (#451)
* improve * add issue templates and improve pr template
1 parent be92f71 commit dbfd78c

5 files changed

Lines changed: 161 additions & 24 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug Report
2+
description: Report a bug you confirmed and could not fix.
3+
labels: ["bug", "status: triage"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: What happened? What did you expect to happen?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: reproduction
15+
attributes:
16+
label: Reproduction Steps
17+
description: Minimal steps to reproduce the issue.
18+
placeholder: |
19+
1. Run `nemoclaw onboard`
20+
2. Select "local" inference
21+
3. ...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: environment
27+
attributes:
28+
label: Environment
29+
description: OS, Node.js version, Docker version, NemoClaw version, and any other relevant details.
30+
placeholder: |
31+
- OS: macOS 15.2 / Ubuntu 24.04 / Windows 11 + WSL2
32+
- Node.js: v20.x
33+
- Docker: Docker Desktop 4.x / Docker Engine 27.x
34+
- NemoClaw: v0.x.x (output of `nemoclaw --version`)
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: logs
40+
attributes:
41+
label: Logs
42+
description: Relevant log output, error messages, or stack traces.
43+
render: shell
44+
validations:
45+
required: false
46+
47+
- type: checkboxes
48+
id: checklist
49+
attributes:
50+
label: Checklist
51+
options:
52+
- label: I confirmed this bug is reproducible
53+
required: true
54+
- label: I searched existing issues and this is not a duplicate
55+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability?
4+
url: https://github.com/NVIDIA/NemoClaw/blob/main/SECURITY.md
5+
about: >
6+
Do not report security vulnerabilities through GitHub issues. Follow
7+
the disclosure process in SECURITY.md.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Documentation Issue
2+
description: Report incorrect, missing, or unclear documentation.
3+
labels: ["documentation", "status: triage"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: What is wrong, missing, or unclear in the docs?
10+
validations:
11+
required: true
12+
13+
- type: input
14+
id: page
15+
attributes:
16+
label: Affected Page
17+
description: URL or file path of the doc page (e.g., docs/get-started/quickstart.md).
18+
placeholder: docs/reference/commands.md
19+
validations:
20+
required: false
21+
22+
- type: dropdown
23+
id: issue-type
24+
attributes:
25+
label: Issue Type
26+
options:
27+
- "Inaccurate information"
28+
- "Missing documentation"
29+
- "Unclear or confusing"
30+
- "Broken link or cross-reference"
31+
- "Formatting or rendering problem"
32+
- "Other"
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: suggestion
38+
attributes:
39+
label: Suggested Fix
40+
description: If you know what the correct content should be, describe it here.
41+
validations:
42+
required: false
Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,51 @@
1-
name: Feature/Enhancement Request
2-
+description: Submit a feature request other enhancement to help us improve NemoClaw
3-
labels: ["status: triage"]
1+
name: Feature Request
2+
description: Propose a feature with a design. Not a "please build this" request.
3+
labels: ["enhancement", "status: triage"]
44
body:
55
- type: textarea
6-
id: desc
6+
id: problem
77
attributes:
8-
label: Proposed Change
9-
placeholder: Describe the feature or provider integration...
8+
label: Problem Statement
9+
description: What problem does this solve? Why does it matter?
1010
validations:
1111
required: true
12+
13+
- type: textarea
14+
id: design
15+
attributes:
16+
label: Proposed Design
17+
description: |
18+
How should this work? Describe the system behavior, components involved, and user-facing interface.
19+
This should be a design, not a wish list.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Alternatives Considered
27+
description: What other approaches did you evaluate? Why is the proposed design better?
28+
validations:
29+
required: false
30+
1231
- type: dropdown
13-
id: cat
32+
id: category
1433
attributes:
15-
label: Suggested Category
16-
options:
34+
label: Category
35+
options:
1736
- "enhancement: feature"
1837
- "enhancement: provider"
1938
- "enhancement: platform"
2039
- "enhancement: testing"
2140
validations:
2241
required: true
42+
43+
- type: checkboxes
44+
id: checklist
45+
attributes:
46+
label: Checklist
47+
options:
48+
- label: I searched existing issues and this is not a duplicate
49+
required: true
50+
- label: This is a design proposal, not a "please build this" request
51+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,32 @@
99

1010
## Type of Change
1111
<!-- Check the one that applies. -->
12-
- [ ] Code change (new feature, bug fix, refactor)
13-
- [ ] Code change with doc updates
14-
- [ ] Doc only — prose changes (no code sample modifications)
15-
- [ ] Doc only — includes code sample changes
12+
- [ ] Code change for a new feature, bug fix, or refactor.
13+
- [ ] Code change with doc updates.
14+
- [ ] Doc only. Prose changes without code sample modifications.
15+
- [ ] Doc only. Includes code sample changes.
1616

1717
## Testing
1818
<!-- What testing was done? -->
19-
- [ ] `make check` passes
20-
- [ ] `npm test` passes
21-
- [ ] `make docs` builds without warnings (for doc changes)
19+
- [ ] `make check` passes.
20+
- [ ] `npm test` passes.
21+
- [ ] `make docs` builds without warnings. (for doc-only changes)
2222

2323
## Checklist
2424

25-
### Code changes
25+
### General
26+
- [ ] I have read and followed the [contributing guide](CONTRIBUTING.md).
27+
- [ ] I have read and followed the [style guide](docs/CONTRIBUTING.md). (for doc-only changes)
28+
29+
### Code Changes
2630
<!-- Skip if this is a doc-only PR. -->
27-
- [ ] `make format` applied (TypeScript and Python)
28-
- [ ] Tests added or updated for new or changed behavior
29-
- [ ] No secrets, API keys, or credentials committed
30-
- [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs)
31+
- [ ] `make format` applied (TypeScript and Python).
32+
- [ ] Tests added or updated for new or changed behavior.
33+
- [ ] No secrets, API keys, or credentials committed.
34+
- [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).
3135

32-
### Doc changes
36+
### Doc Changes
3337
<!-- Skip if this PR has no doc changes. -->
3438
- [ ] Follows the [style guide](docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR."
35-
- [ ] New pages include SPDX license header and frontmatter (if creating a new page)
36-
- [ ] Cross-references and links verified
39+
- [ ] New pages include SPDX license header and frontmatter, if creating a new page.
40+
- [ ] Cross-references and links verified.

0 commit comments

Comments
 (0)