Skip to content

Commit 7a8eea4

Browse files
authored
feat: add issue templates
1 parent cd7fcb4 commit 7a8eea4

File tree

2 files changed

+215
-0
lines changed

2 files changed

+215
-0
lines changed
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
name: "✨ Feature request"
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## ✨ Feature summary
11+
12+
**Describe the feature or improvement clearly and concisely.**
13+
What problem does it solve? What value does it add?
14+
15+
---
16+
17+
## 🎯 Motivation
18+
19+
Why is this feature important?
20+
21+
- What pain point does it address?
22+
- Who would benefit from it?
23+
- Is this related to security, performance, DX, or CI?
24+
25+
---
26+
27+
## 🧠 Proposed solution
28+
29+
Describe how you imagine this feature working.
30+
31+
- New CLI flag?
32+
- New configuration option?
33+
- New rule type?
34+
- Behavior change?
35+
36+
Example (if applicable):
37+
```bash
38+
secretscout scan . --new-feature
39+
````
40+
41+
---
42+
43+
## 🔄 Alternatives considered
44+
45+
Have you considered alternative approaches?
46+
47+
* Different CLI syntax?
48+
* Configuration-only solution?
49+
* External tooling?
50+
51+
Explain why the proposed solution is preferred.
52+
53+
---
54+
55+
## ⚠️ Scope & constraints
56+
57+
Please consider:
58+
59+
* Should this be **optional** or **enabled by default**?
60+
* Any performance impact?
61+
* Any backward compatibility concerns?
62+
* Does this affect pre-commit or CI behavior?
63+
64+
---
65+
66+
## 🔐 Security considerations
67+
68+
Does this feature introduce any security or privacy concerns?
69+
70+
* [ ] No
71+
* [ ] Yes (please explain below)
72+
73+
> SecretScout is **defensive-only**.
74+
> Features that enable offensive use will not be accepted.
75+
76+
---
77+
78+
## 🧪 How should this be tested?
79+
80+
Describe how this feature could be tested:
81+
82+
* CLI usage examples
83+
* Expected output
84+
* Edge cases
85+
86+
---
87+
88+
## 🧩 Additional context
89+
90+
Add any other context, references, or examples:
91+
92+
* Related tools or projects
93+
* Links to issues or discussions
94+
* Screenshots / mockups (if relevant)
95+
96+
---
97+
98+
🙏 Thank you for helping shape the future of **SecretScout**!
Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: Report a bug or unexpected behavior in SecretScout
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## 🐞 Bug description
11+
12+
**Describe the bug clearly and concisely.**
13+
What went wrong? What did you expect instead?
14+
15+
---
16+
17+
## 🔁 Steps to reproduce
18+
19+
Steps to reproduce the behavior:
20+
21+
1. Run command:
22+
```bash
23+
secretscout scan .
24+
```
25+
26+
2. Use configuration:
27+
28+
* `.secretscout.toml`: yes / no
29+
* `.secretscoutignore`: yes / no
30+
3. See error / unexpected output
31+
32+
> ⚠️ **Do not include real secrets.**
33+
> Use dummy values only (e.g. `ghp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`).
34+
35+
---
36+
37+
## ✅ Expected behavior
38+
39+
A clear and concise description of what you expected to happen.
40+
41+
---
42+
43+
## ❌ Actual behavior
44+
45+
What actually happened?
46+
Include error messages, incorrect output, or unexpected results.
47+
48+
---
49+
50+
## 📄 Command output / logs
51+
52+
If applicable, paste relevant output here:
53+
54+
```text
55+
(secretscout output or traceback)
56+
```
57+
58+
> Secrets in logs **must be redacted**.
59+
60+
---
61+
62+
## 🖥️ Environment
63+
64+
Please complete the following information:
65+
66+
* OS: (e.g. Windows 11, Ubuntu 22.04, macOS Sonoma)
67+
* Python version:
68+
69+
```bash
70+
python --version
71+
```
72+
* SecretScout version:
73+
74+
```bash
75+
secretscout --version
76+
```
77+
* Installation method:
78+
79+
* [ ] Editable install (`pip install -e .`)
80+
* [ ] PyPI (if applicable)
81+
* [ ] Other
82+
83+
---
84+
85+
## 🧷 Git / Pre-commit context (if relevant)
86+
87+
* Is this running via **pre-commit**?
88+
89+
* [ ] Yes
90+
* [ ] No
91+
* Command used:
92+
93+
```bash
94+
secretscout scan --staged ...
95+
```
96+
97+
---
98+
99+
## 📸 Screenshots (optional)
100+
101+
If applicable, add screenshots to help explain the problem.
102+
103+
---
104+
105+
## 🧠 Additional context
106+
107+
Add any other context that might help us understand or reproduce the issue:
108+
109+
* custom rules
110+
* baseline usage
111+
* CI environment
112+
* large repositories
113+
* performance-related notes
114+
115+
---
116+
117+
🙏 Thank you for helping improve **SecretScout**!

0 commit comments

Comments
 (0)