Skip to content

Commit 9537856

Browse files
jeleel-muibijeleel-muibi
authored
Add GitHub issue and PR templates (#8)
Co-authored-by: Jeleel Muibi <jeleel-muibi@users.noreply.github.com>
1 parent a7bb82b commit 9537856

5 files changed

Lines changed: 179 additions & 0 deletions

File tree

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

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Workload target defect
2+
description: Report a reproducible problem with a workload target, app overlay, or validation path.
3+
title: "[bug] "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Do not include kubeconfigs, tokens, private domains, customer data, or unredacted secrets.
11+
- type: dropdown
12+
id: target
13+
attributes:
14+
label: Target
15+
options:
16+
- onprem-smoke
17+
- onprem-stage1
18+
- onprem
19+
- burst
20+
- not target-specific
21+
validations:
22+
required: true
23+
- type: dropdown
24+
id: area
25+
attributes:
26+
label: Area
27+
options:
28+
- Validation script
29+
- Kustomize render
30+
- Argo CD sync
31+
- App overlay
32+
- Documentation or rollout guide
33+
- Tooling
34+
validations:
35+
required: true
36+
- type: input
37+
id: reference
38+
attributes:
39+
label: Relevant reference
40+
description: Target, app, path, command, or revision involved.
41+
placeholder: clusters/onprem-stage1, apps/platform/velero, scripts/validate.sh
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: expected
46+
attributes:
47+
label: Expected behaviour
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: observed
52+
attributes:
53+
label: Observed behaviour
54+
description: Include the exact error or result, with sensitive data removed.
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: reproduce
59+
attributes:
60+
label: Steps to reproduce
61+
placeholder: |
62+
1. Run ./scripts/validate.sh --target ...
63+
2. Render ...
64+
3. Observe ...
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: environment
69+
attributes:
70+
label: Environment
71+
description: Include OS, Kubernetes version if relevant, Kustomize version if relevant, and whether this was render-only or cluster-side.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security report
4+
url: mailto:security@hybridops.tech
5+
about: Report suspected vulnerabilities privately. Do not open a public issue.

‎.github/ISSUE_TEMPLATE/improvement.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Focused improvement
2+
description: Propose a bounded improvement to the workload repository.
3+
title: "[improvement] "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Direct pull requests are welcome for contained improvements. Use this form when the change needs agreement before implementation.
11+
- type: dropdown
12+
id: area
13+
attributes:
14+
label: Area
15+
options:
16+
- Cluster target
17+
- App overlay
18+
- Validation or CI
19+
- Argo CD model
20+
- Documentation or rollout guide
21+
- Tooling
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: problem
26+
attributes:
27+
label: Problem
28+
description: Describe the operator or contributor problem this would solve.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: proposal
33+
attributes:
34+
label: Proposed change
35+
description: Keep the proposal bounded. Link targets, apps, scripts, or docs where useful.
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: acceptance
40+
attributes:
41+
label: Acceptance criteria
42+
description: What should be demonstrably true when the change is complete?
43+
- type: checkboxes
44+
id: contribution
45+
attributes:
46+
label: Contribution
47+
options:
48+
- label: I can work on a pull request for this change.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Usage question or target clarification
2+
description: Ask a focused question about targets, overlays, validation, or safe adoption.
3+
title: "[question] "
4+
labels:
5+
- question
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this for focused questions. Do not paste kubeconfigs, tokens, private domains, or unredacted secrets.
11+
- type: dropdown
12+
id: target
13+
attributes:
14+
label: Target
15+
options:
16+
- onprem-smoke
17+
- onprem-stage1
18+
- onprem
19+
- burst
20+
- not target-specific
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: question
25+
attributes:
26+
label: Question
27+
description: Ask the specific thing you need clarified.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: context
32+
attributes:
33+
label: Context
34+
description: Include the target, app, path, or command if known. Say if this is based on docs review rather than a live run.
35+
- type: textarea
36+
id: checked
37+
attributes:
38+
label: What you checked
39+
description: Link the README section, rollout guide, issue, or command you already reviewed.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Summary
2+
3+
<!-- What problem does this change solve? Link the issue if one exists. -->
4+
5+
Closes #
6+
7+
## Validation
8+
9+
<!-- List the checks or commands you ran, for example ./scripts/validate.sh --target onprem-smoke. Say whether validation was render-only or cluster-side. -->
10+
11+
## Scope
12+
13+
- [ ] This pull request is focused on one change.
14+
- [ ] I have not included kubeconfigs, tokens, private domains, customer data, or secrets.
15+
- [ ] I updated documentation, examples, or validation where the change needs them.
16+
- [ ] I kept environment-specific wiring out of the public workload repo.

0 commit comments

Comments
 (0)