Skip to content

Commit f3a8a01

Browse files
authored
Merge pull request #54 from advaitpatel/chore/clean-up-issue-and-pr-templates
chore(templates): remove emojis and filler text from PR and issue templates
2 parents 9ac07b2 + 6d0d635 commit f3a8a01

5 files changed

Lines changed: 82 additions & 141 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 20 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,27 @@ assignees: ''
77

88
---
99

10-
## 🐛 Bug Description
10+
## Bug Description
1111

1212
A clear and concise description of what the bug is.
1313

14-
## 📋 To Reproduce
14+
## To Reproduce
1515

1616
Steps to reproduce the behavior:
1717

1818
1. Run command: `docksec ...`
19-
2. With Dockerfile containing: '...'
20-
3. See error: '...'
19+
2. With Dockerfile containing: `...`
20+
3. See error: `...`
2121

22-
## Expected Behavior
22+
## Expected Behavior
2323

24-
A clear and concise description of what you expected to happen.
24+
What you expected to happen.
2525

26-
## Actual Behavior
26+
## Actual Behavior
2727

2828
What actually happened instead.
2929

30-
## 📊 Environment
30+
## Environment
3131

3232
**DockSec Version:**
3333
```bash
@@ -37,7 +37,7 @@ pip show docksec
3737
**Operating System:**
3838
- [ ] Windows
3939
- [ ] macOS
40-
- [ ] Linux (which distribution?)
40+
- [ ] Linux (distribution: )
4141

4242
**Python Version:**
4343
```bash
@@ -55,45 +55,33 @@ trivy --version
5555
hadolint --version
5656
```
5757

58-
## 📝 Additional Context
59-
60-
### Error Message/Logs
58+
## Error Message / Logs
6159

6260
```
6361
Paste error message or relevant logs here
6462
```
6563

66-
### Configuration
64+
## Configuration
6765

6866
```bash
6967
# Contents of .env file (remove sensitive data)
7068
LLM_MODEL=gpt-4o
7169
TRIVY_SCAN_TIMEOUT=600
72-
# ... etc
7370
```
7471

75-
### Dockerfile (if relevant)
72+
## Dockerfile (if relevant)
7673

7774
```dockerfile
78-
# Your Dockerfile content here (if it helps reproduce the issue)
75+
# Your Dockerfile content here
7976
```
8077

81-
## 🔍 Possible Solution
82-
83-
If you have ideas on how to fix this, please share them here.
84-
85-
## ✔️ Checklist
78+
## Possible Solution
8679

87-
- [ ] I have searched existing issues to avoid duplicates
88-
- [ ] I have provided all the required information above
89-
- [ ] I have tested with the latest version of DockSec
90-
- [ ] I have included error messages and logs
91-
- [ ] I have removed any sensitive information (API keys, passwords, etc.)
80+
If you have ideas on how to fix this, share them here.
9281

93-
## 📸 Screenshots
94-
95-
If applicable, add screenshots to help explain your problem.
96-
97-
---
82+
## Checklist
9883

99-
**Thank you for taking the time to report this bug! We'll look into it as soon as possible.**
84+
- [ ] Searched existing issues to avoid duplicates
85+
- [ ] Tested with the latest version of DockSec
86+
- [ ] Included error messages and logs
87+
- [ ] Removed any sensitive information (API keys, passwords, etc.)

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 18 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -7,94 +7,56 @@ assignees: ''
77

88
---
99

10-
## 🚀 Feature Request
10+
## Summary
1111

1212
A clear and concise description of the feature you'd like to see.
1313

14-
## 💡 Problem Statement
14+
## Problem Statement
1515

16-
**Is your feature request related to a problem? Please describe.**
16+
What problem does this solve? Describe the gap or friction you're experiencing.
1717

18-
A clear description of what the problem is. Ex. "I'm always frustrated when..."
18+
## Proposed Solution
1919

20-
## 🎯 Proposed Solution
21-
22-
**Describe the solution you'd like**
23-
24-
A clear and concise description of what you want to happen.
20+
What you want to happen.
2521

2622
**Example Usage:**
2723

2824
```bash
29-
# How would you use this feature?
25+
# How would this feature be used?
3026
docksec --new-feature path/to/Dockerfile
3127
```
3228

33-
## 🔄 Alternatives Considered
29+
## Alternatives Considered
3430

35-
**Describe alternatives you've considered**
31+
Any alternative approaches you've thought about.
3632

37-
A clear and concise description of any alternative solutions or features you've considered.
33+
## Use Case
3834

39-
## 📊 Use Case
40-
41-
**Who would benefit from this feature?**
35+
Who would benefit from this feature?
4236

4337
- [ ] Individual developers
4438
- [ ] DevOps teams
4539
- [ ] Security teams
4640
- [ ] CI/CD pipelines
4741
- [ ] Enterprise users
48-
- [ ] Other: ___________
49-
50-
**How often would you use this feature?**
51-
52-
- [ ] Daily
53-
- [ ] Weekly
54-
- [ ] Monthly
55-
- [ ] Occasionally
56-
- [ ] One-time use
57-
58-
## 🎨 Additional Context
59-
60-
Add any other context, mockups, or screenshots about the feature request here.
61-
62-
**Examples from other tools:**
42+
- [ ] Other:
6343

64-
If you've seen this feature implemented elsewhere, please share examples.
44+
## Acceptance Criteria
6545

66-
## ✅ Acceptance Criteria
67-
68-
What would make this feature complete and ready to use?
46+
What does done look like?
6947

7048
- [ ] Criteria 1
7149
- [ ] Criteria 2
7250
- [ ] Criteria 3
7351

74-
## 📝 Implementation Ideas
52+
## Implementation Ideas
7553

76-
If you have technical ideas on how to implement this, please share:
54+
Optional — share any technical thoughts on how this could be implemented:
7755

7856
```python
79-
# Pseudo-code or high-level implementation ideas
57+
# Pseudo-code or high-level ideas
8058
```
8159

82-
## 🔗 Related Issues
83-
84-
Are there any related issues or PRs? Link them here:
85-
86-
- #123
87-
- #456
88-
89-
## ⚡ Priority
90-
91-
How important is this feature to you?
92-
93-
- [ ] Critical - Blocking my work
94-
- [ ] High - Would significantly improve my workflow
95-
- [ ] Medium - Nice to have
96-
- [ ] Low - Interesting idea for the future
97-
98-
---
60+
## Related Issues
9961

100-
**Thank you for suggesting this feature! We value your input and will review it carefully.**
62+
- #

.github/ISSUE_TEMPLATE/question.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ assignees: ''
77

88
---
99

10-
## Question
10+
## Question
1111

1212
A clear and concise question.
1313

14-
## 🔍 Context
14+
## Context
1515

1616
**What are you trying to accomplish?**
1717

@@ -23,20 +23,19 @@ Describe what you're working on and what you're trying to achieve with DockSec.
2323
- Checked documentation: [link]
2424
- Searched issues: [link]
2525

26-
## 📊 Environment (if relevant)
26+
## Environment (if relevant)
2727

28-
- DockSec version:
29-
- Operating System:
30-
- Python version:
28+
- DockSec version:
29+
- Operating System:
30+
- Python version:
3131

32-
## 📝 Additional Information
32+
## Additional Information
3333

34-
Any additional information that might help us answer your question.
34+
Any additional information that might help answer the question.
3535

3636
---
3737

38-
**Note**: Before asking, please check:
38+
Before asking, please check:
3939
- [ ] [README documentation](https://github.com/advaitpatel/DockSec/blob/main/README.md)
40-
- [ ] [Troubleshooting guide](https://github.com/advaitpatel/DockSec/blob/main/README.md#-troubleshooting)
4140
- [ ] [Existing issues](https://github.com/advaitpatel/DockSec/issues)
4241
- [ ] [Examples directory](https://github.com/advaitpatel/DockSec/tree/main/examples)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,55 @@
11
# Pull Request
22

3-
## 📝 Description
3+
## Description
44

5-
Please include a summary of the changes and the related issue. Include relevant motivation and context.
5+
Summary of the changes and the related issue. Include motivation and context.
66

7-
Fixes # (issue)
7+
Closes #
88

9-
## 🎯 Type of Change
9+
## Type of Change
1010

11-
Please delete options that are not relevant:
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Breaking change
14+
- [ ] Documentation update
15+
- [ ] Code style update (formatting, renaming)
16+
- [ ] Code refactoring (no functional changes)
17+
- [ ] Performance improvement
18+
- [ ] Test update
19+
- [ ] Build / CI configuration
20+
- [ ] Security fix
1221

13-
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
14-
- [ ] ✨ New feature (non-breaking change which adds functionality)
15-
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
16-
- [ ] 📝 Documentation update
17-
- [ ] 🎨 Code style update (formatting, renaming)
18-
- [ ] ♻️ Code refactoring (no functional changes)
19-
- [ ] ⚡ Performance improvement
20-
- [ ] ✅ Test update
21-
- [ ] 🔧 Build/CI configuration
22-
- [ ] 🔒 Security fix
22+
## How Has This Been Tested?
2323

24-
## 🧪 How Has This Been Tested?
24+
Describe the tests run to verify the changes:
2525

26-
Please describe the tests that you ran to verify your changes:
26+
- [ ] Unit tests
27+
- [ ] Manual testing
2728

28-
- [ ] Test A
29-
- [ ] Test B
30-
31-
**Test Configuration**:
29+
**Test Configuration:**
3230
- Python version:
3331
- Operating System:
3432
- DockSec version:
3533

36-
## 📋 Checklist
37-
38-
- [ ] My code follows the style guidelines of this project
39-
- [ ] I have performed a self-review of my own code
40-
- [ ] I have commented my code, particularly in hard-to-understand areas
41-
- [ ] I have made corresponding changes to the documentation
42-
- [ ] My changes generate no new warnings or errors
43-
- [ ] I have added tests that prove my fix is effective or that my feature works
44-
- [ ] New and existing unit tests pass locally with my changes
45-
- [ ] Any dependent changes have been merged and published
46-
- [ ] I have checked my code and corrected any misspellings
47-
48-
## 📸 Screenshots (if applicable)
34+
## Checklist
4935

50-
Add screenshots to help explain your changes.
36+
- [ ] Code follows the style guidelines of this project
37+
- [ ] Self-review completed
38+
- [ ] Hard-to-understand areas are commented
39+
- [ ] Documentation updated where needed
40+
- [ ] No new warnings or errors introduced
41+
- [ ] Tests added that prove the fix or feature works
42+
- [ ] All existing tests pass
43+
- [ ] Dependent changes have been merged and published
44+
- [ ] Spelling checked
5145

52-
## 🔗 Related Issues/PRs
46+
## Screenshots (if applicable)
5347

54-
Link any related issues or pull requests:
48+
## Related Issues / PRs
5549

5650
- Relates to #
57-
- Closes #
5851
- Depends on #
5952

60-
## 📚 Additional Notes
61-
62-
Any additional information that reviewers should know.
63-
6453
---
6554

66-
**By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.**
55+
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,6 @@ SESSION_SUMMARY.md
193193
CURSOR_CONFIGURATION.md
194194

195195
# Internal/maintainer documentation (not for public repository)
196+
197+
# Claude Code project instructions (local only, not for public repository)
198+
CLAUDE.md

0 commit comments

Comments
 (0)