Skip to content

Commit 059ac48

Browse files
WilliamBerryiiiWilliamBerryiii
authored
feat: add PR template and YAML issue form templates (#16)
- add pull request template with change types and testing checklist - add bug report, feature request, infrastructure, training, and documentation issue forms - add template chooser config with external links - remove legacy ISSUE_TEMPLATE.md in favor of YAML forms ✨ - Generated by Copilot
1 parent ff8ffd2 commit 059ac48

File tree

9 files changed

+469
-33
lines changed

9 files changed

+469
-33
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/00-general.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: 📝 General Issue
3+
about: General issue that doesn't fit other categories
4+
title: ""
5+
labels: ["needs-triage"]
6+
---
7+
8+
<!--
9+
Thank you for contributing to the Azure NVIDIA Robotics Reference Architecture!
10+
Please fill out the sections below to help us understand your issue.
11+
-->
12+
13+
## Summary
14+
15+
<!-- One or two sentences describing the issue -->
16+
17+
## Category
18+
19+
<!-- Check the category that best fits your issue -->
20+
21+
- [ ] Question or clarification
22+
- [ ] Improvement suggestion
23+
- [ ] Integration help (OSMO, Isaac Lab, Azure)
24+
- [ ] Other
25+
26+
## Description
27+
28+
<!--
29+
Provide details about your issue:
30+
- What are you trying to accomplish?
31+
- What behavior did you observe?
32+
- What did you expect instead?
33+
-->
34+
35+
## Relevant Context
36+
37+
<!--
38+
Include any relevant information:
39+
- Related files or components (e.g., deploy/001-iac, src/training)
40+
- Links to documentation you've consulted
41+
- Screenshots or diagrams if helpful
42+
-->
43+
44+
## Environment
45+
46+
<!-- Fill in if relevant to your issue -->
47+
48+
| Component | Version |
49+
|-----------|---------|
50+
| OS | Ubuntu 22.04 / Windows 11 |
51+
| Python | 3.10.x / 3.11.x |
52+
| Terraform | 1.9.x |
53+
| Azure CLI | 2.x |
54+
| Isaac Sim | 4.5 / 5.0 |
55+
| GPU | NVIDIA RTX / A100 |
56+
57+
## Additional Notes
58+
59+
<!-- Any other information that might be helpful -->
60+
61+
---
62+
63+
**Before submitting:**
64+
65+
- [ ] I have searched [existing issues](https://github.com/Azure-Samples/azure-nvidia-robotics-reference-architecture/issues) for duplicates
66+
- [ ] I have reviewed the [README](README.md) and [documentation](docs/)

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

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
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+
## Thank you for reporting a bug!
10+
Please search [existing issues](https://github.com/Azure-Samples/azure-nvidia-robotics-reference-architecture/issues) before submitting.
11+
12+
- type: dropdown
13+
id: component
14+
attributes:
15+
label: Component
16+
description: Which component is affected?
17+
options:
18+
- Infrastructure (Terraform/Azure)
19+
- OSMO Control Plane (Helm/Kubernetes)
20+
- Training Scripts (Python/SKRL/RSL-RL)
21+
- Training Workflows (OSMO)
22+
- Documentation
23+
- Development Environment
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: description
29+
attributes:
30+
label: Bug Description
31+
description: Clear and concise description of the bug
32+
placeholder: Describe what happened...
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: reproduction
38+
attributes:
39+
label: Steps to Reproduce
40+
description: Minimal steps to reproduce the behavior
41+
value: |
42+
1.
43+
2.
44+
3.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: Expected Behavior
52+
description: What did you expect to happen?
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: environment
58+
attributes:
59+
label: Environment
60+
description: Provide relevant environment details
61+
placeholder: |
62+
- OS: Ubuntu 22.04 / Windows 11
63+
- Python version: 3.10.x / 3.11.x
64+
- Terraform version: 1.9.x
65+
- Azure CLI version: 2.x
66+
- Isaac Sim version: 4.5 / 5.0
67+
- GPU: NVIDIA RTX 4090 / A100
68+
validations:
69+
required: false
70+
71+
- type: textarea
72+
id: logs
73+
attributes:
74+
label: Logs / Error Output
75+
description: Paste relevant logs or error messages
76+
render: shell
77+
validations:
78+
required: false
79+
80+
- type: checkboxes
81+
id: checklist
82+
attributes:
83+
label: Checklist
84+
options:
85+
- label: I have searched existing issues for duplicates
86+
required: true
87+
- label: I have read the [documentation](README.md)
88+
required: true

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

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: ✨ Feature Request
2+
description: Propose a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Feature Request
10+
Please describe the feature you'd like to see.
11+
12+
- type: dropdown
13+
id: component
14+
attributes:
15+
label: Component
16+
description: Which component would this feature affect?
17+
options:
18+
- Infrastructure (Terraform/Azure)
19+
- OSMO Control Plane
20+
- Training Scripts
21+
- Training Workflows
22+
- Documentation
23+
- Development Environment
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: problem
30+
attributes:
31+
label: Problem Statement
32+
description: What problem does this feature solve?
33+
placeholder: "I'm trying to accomplish X but currently..."
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: solution
39+
attributes:
40+
label: Proposed Solution
41+
description: Describe your proposed solution
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: alternatives
47+
attributes:
48+
label: Alternatives Considered
49+
description: What alternatives have you considered?
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: context
55+
attributes:
56+
label: Additional Context
57+
description: Any other context, screenshots, or references
58+
validations:
59+
required: false

‎.github/ISSUE_TEMPLATE/03-infrastructure-issue.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: 🏗️ Infrastructure Issue
2+
description: Report issues with Terraform or Azure resources
3+
title: "[Infra]: "
4+
labels: ["infrastructure", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Infrastructure Issue
10+
For Terraform, Azure resources, networking, or AKS issues.
11+
12+
- type: dropdown
13+
id: issue-type
14+
attributes:
15+
label: Issue Type
16+
options:
17+
- Terraform provisioning error
18+
- Azure resource configuration
19+
- Kubernetes/AKS issue
20+
- Networking/DNS
21+
- Authentication/Identity
22+
- Other
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: terraform-version
28+
attributes:
29+
label: Terraform Version
30+
placeholder: "1.9.8"
31+
validations:
32+
required: false
33+
34+
- type: input
35+
id: azure-region
36+
attributes:
37+
label: Azure Region
38+
placeholder: "eastus2"
39+
validations:
40+
required: false
41+
42+
- type: input
43+
id: resource-module
44+
attributes:
45+
label: Resource/Module Affected
46+
placeholder: "azurerm_kubernetes_cluster, module.robotics"
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: description
52+
attributes:
53+
label: Issue Description
54+
description: Describe the infrastructure issue
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: terraform-output
60+
attributes:
61+
label: Terraform Plan/Apply Output
62+
description: Paste relevant Terraform output
63+
render: hcl
64+
validations:
65+
required: false
66+
67+
- type: textarea
68+
id: config-snippet
69+
attributes:
70+
label: Relevant Configuration
71+
description: Paste relevant Terraform/variable configuration (sanitize secrets!)
72+
render: hcl
73+
validations:
74+
required: false
75+
76+
- type: checkboxes
77+
id: checklist
78+
attributes:
79+
label: Checklist
80+
options:
81+
- label: I have sanitized any secrets from the configuration
82+
required: true

0 commit comments

Comments
 (0)