Skip to content

Commit fc5935d

Browse files
committed
docs(github): create issue templates for bugs and feature requests
1 parent 0f24d1a commit fc5935d

File tree

6 files changed

+144
-22
lines changed

6 files changed

+144
-22
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve `propeller`
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## `propeller` Version
14+
15+
Please run `propeller --version` and paste the output here:
16+
17+
```
18+
[Paste the version information here]
19+
```
20+
21+
## Target Platform
22+
23+
- [ ] Linux
24+
- [ ] Windows
25+
26+
### Environment Details (please complete the following information):
27+
28+
- OS: [e.g. Ubuntu 20.04, Windows 10]
29+
- Shell: [e.g. bash, powershell]
30+
- Relevant tool versions: [e.g. Kubernetes v1.21, ArgoCD v2.1.2]
31+
32+
## Steps to Reproduce
33+
34+
1. Create '...'
35+
2. Configure '...'
36+
3. Execute '...'
37+
4. See error
38+
39+
## Actual (Buggy) Behavior
40+
41+
A clear and concise description of what actually happens when you follow the steps above.
42+
43+
## Expected Behavior
44+
45+
A clear and concise description of what you expected to happen.
46+
47+
## Configuration
48+
49+
If applicable, provide relevant configuration files or snippets (make sure to remove any sensitive information).
50+
51+
## Logs
52+
53+
Please provide any relevant log output. Use code blocks (```) to format the log output.
54+
55+
## Additional Context
56+
57+
Add any other context about the problem here. For example:
58+
59+
- Does this happen consistently or intermittently?
60+
- Were there any recent changes in your environment?
61+
- Have you tried any troubleshooting steps?
62+
63+
## Possible Solution
64+
65+
If you have any ideas on how to solve the issue, please share them here.
+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for `propeller`
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see implemented.
12+
13+
## Problem Statement
14+
15+
Describe the problem this feature would solve. For example: "I'm always frustrated when [...]"
16+
17+
## Proposed Solution
18+
19+
A clear and concise description of what you want to happen.
20+
If you have specific ideas about how this feature could be implemented, please share them here.
21+
22+
## Alternative Solutions
23+
24+
Have you considered any alternative solutions or features? If so, please describe them here.
25+
26+
## Use Case
27+
28+
Describe a concrete use case for this feature. How would you (or others) use this feature in practice?
29+
30+
## Benefits
31+
32+
List the benefits this feature would bring to `propeller` users.
33+
34+
## Potential Drawbacks
35+
36+
Are there any potential drawbacks or trade-offs to implementing this feature? Please describe them here.
37+
38+
## Additional Context
39+
40+
Add any other context, screenshots, or examples about the feature request here.
41+
If this feature request is related to a specific version of `propeller` or a particular environment, please provide those details.
42+
43+
## Are you willing to contribute?
44+
45+
- [ ] I'm willing to submit a pull request to implement this feature
46+
- [ ] I'm willing to test this feature once it's implemented
47+
- [ ] I'm interested in discussing this feature further
48+
- [ ] I'm just suggesting the idea for now
49+
50+
## Priority
51+
52+
How important is this feature to you?
53+
54+
- [ ] Critical: I can't use `propeller` effectively without it
55+
- [ ] High: It would significantly improve my experience with `propeller`
56+
- [ ] Medium: It would be a nice addition, but I can work around it
57+
- [ ] Low: It's just an idea I had

.github/dependabot.yml

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "github-actions"
4-
directory: "/"
3+
- package-ecosystem: 'github-actions'
4+
directory: '/'
55
schedule:
6-
interval: "weekly"
7-
- package-ecosystem: "cargo"
8-
directory: "/"
6+
interval: 'weekly'
7+
- package-ecosystem: 'cargo'
8+
directory: '/'
99
schedule:
10-
interval: "daily"
11-
- package-ecosystem: "npm"
12-
directory: "/"
10+
interval: 'daily'
11+
- package-ecosystem: 'npm'
12+
directory: '/'
1313
schedule:
14-
interval: "daily"
15-
- package-ecosystem: "gitsubmodule"
16-
directory: "/argo-cd"
14+
interval: 'daily'
15+
- package-ecosystem: 'gitsubmodule'
16+
directory: '/argo-cd'
1717
schedule:
18-
interval: "daily"
19-
- package-ecosystem: "cargo"
20-
directory: "/utilities"
18+
interval: 'daily'
19+
- package-ecosystem: 'cargo'
20+
directory: '/utilities'
2121
schedule:
22-
interval: "daily"
22+
interval: 'daily'

.github/labeler.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ bug:
44
ci/cd:
55
- changed-files:
66
- any-glob-to-any-file:
7-
- '.github/**/*'
8-
- '*.js'
7+
- '.github/**/*'
8+
- '*.js'
99

1010
dependencies:
1111
- changed-files:
1212
- any-glob-to-any-file:
13-
- 'Cargo.*'
14-
- 'package*.json'
13+
- 'Cargo.*'
14+
- 'package*.json'
1515

1616
documentation:
1717
- changed-files:
1818
- any-glob-to-any-file:
19-
- '*.md'
19+
- '*.md'
2020

2121
feature:
2222
- head-branch: ['^feat', 'feature']

.lintstagedrc.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module.exports = {
2-
'{,.github/workflows/,dev/**/,tests/resources/**/}*.{md,js,json,y(a|)ml}': ['prettier --write'],
2+
'{,.github/**/,dev/**/,tests/resources/**/}*.{md,js,json,y(a|)ml}': ['prettier --write'],
33
};

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"counterfact:argocd": "counterfact argo-cd/assets/swagger.json target/counterfact/argocd",
1818
"openapi:generate:argocd": "openapi-generator-cli generate -i argo-cd/assets/swagger.json -g rust -o target/argo-cd",
1919
"prepare": "husky",
20-
"prettier": "prettier \"{,.github/workflows/,dev/**/,tests/resources/**/}*.{md,js,json,y(a|)ml}\"",
20+
"prettier": "prettier \"{,.github/**/,dev/**/,tests/resources/**/}*.{md,js,json,y(a|)ml}\"",
2121
"prettier:check": "npm run prettier -- --check",
2222
"prettier:format": "npm run prettier -- --write"
2323
},

0 commit comments

Comments
 (0)