Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 20 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,27 @@ assignees: ''

---

## 🐛 Bug Description
## Bug Description

A clear and concise description of what the bug is.

## 📋 To Reproduce
## To Reproduce

Steps to reproduce the behavior:

1. Run command: `docksec ...`
2. With Dockerfile containing: '...'
3. See error: '...'
2. With Dockerfile containing: `...`
3. See error: `...`

## Expected Behavior
## Expected Behavior

A clear and concise description of what you expected to happen.
What you expected to happen.

## Actual Behavior
## Actual Behavior

What actually happened instead.

## 📊 Environment
## Environment

**DockSec Version:**
```bash
Expand All @@ -37,7 +37,7 @@ pip show docksec
**Operating System:**
- [ ] Windows
- [ ] macOS
- [ ] Linux (which distribution?)
- [ ] Linux (distribution: )

**Python Version:**
```bash
Expand All @@ -55,45 +55,33 @@ trivy --version
hadolint --version
```

## 📝 Additional Context

### Error Message/Logs
## Error Message / Logs

```
Paste error message or relevant logs here
```

### Configuration
## Configuration

```bash
# Contents of .env file (remove sensitive data)
LLM_MODEL=gpt-4o
TRIVY_SCAN_TIMEOUT=600
# ... etc
```

### Dockerfile (if relevant)
## Dockerfile (if relevant)

```dockerfile
# Your Dockerfile content here (if it helps reproduce the issue)
# Your Dockerfile content here
```

## 🔍 Possible Solution

If you have ideas on how to fix this, please share them here.

## ✔️ Checklist
## Possible Solution

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

## 📸 Screenshots

If applicable, add screenshots to help explain your problem.

---
## Checklist

**Thank you for taking the time to report this bug! We'll look into it as soon as possible.**
- [ ] Searched existing issues to avoid duplicates
- [ ] Tested with the latest version of DockSec
- [ ] Included error messages and logs
- [ ] Removed any sensitive information (API keys, passwords, etc.)
74 changes: 18 additions & 56 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,94 +7,56 @@ assignees: ''

---

## 🚀 Feature Request
## Summary

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

## 💡 Problem Statement
## Problem Statement

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

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

## 🎯 Proposed Solution

**Describe the solution you'd like**

A clear and concise description of what you want to happen.
What you want to happen.

**Example Usage:**

```bash
# How would you use this feature?
# How would this feature be used?
docksec --new-feature path/to/Dockerfile
```

## 🔄 Alternatives Considered
## Alternatives Considered

**Describe alternatives you've considered**
Any alternative approaches you've thought about.

A clear and concise description of any alternative solutions or features you've considered.
## Use Case

## 📊 Use Case

**Who would benefit from this feature?**
Who would benefit from this feature?

- [ ] Individual developers
- [ ] DevOps teams
- [ ] Security teams
- [ ] CI/CD pipelines
- [ ] Enterprise users
- [ ] Other: ___________

**How often would you use this feature?**

- [ ] Daily
- [ ] Weekly
- [ ] Monthly
- [ ] Occasionally
- [ ] One-time use

## 🎨 Additional Context

Add any other context, mockups, or screenshots about the feature request here.

**Examples from other tools:**
- [ ] Other:

If you've seen this feature implemented elsewhere, please share examples.
## Acceptance Criteria

## ✅ Acceptance Criteria

What would make this feature complete and ready to use?
What does done look like?

- [ ] Criteria 1
- [ ] Criteria 2
- [ ] Criteria 3

## 📝 Implementation Ideas
## Implementation Ideas

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

```python
# Pseudo-code or high-level implementation ideas
# Pseudo-code or high-level ideas
```

## 🔗 Related Issues

Are there any related issues or PRs? Link them here:

- #123
- #456

## ⚡ Priority

How important is this feature to you?

- [ ] Critical - Blocking my work
- [ ] High - Would significantly improve my workflow
- [ ] Medium - Nice to have
- [ ] Low - Interesting idea for the future

---
## Related Issues

**Thank you for suggesting this feature! We value your input and will review it carefully.**
- #
19 changes: 9 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assignees: ''

---

## Question
## Question

A clear and concise question.

## 🔍 Context
## Context

**What are you trying to accomplish?**

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

## 📊 Environment (if relevant)
## Environment (if relevant)

- DockSec version:
- Operating System:
- Python version:
- DockSec version:
- Operating System:
- Python version:

## 📝 Additional Information
## Additional Information

Any additional information that might help us answer your question.
Any additional information that might help answer the question.

---

**Note**: Before asking, please check:
Before asking, please check:
- [ ] [README documentation](https://github.com/advaitpatel/DockSec/blob/main/README.md)
- [ ] [Troubleshooting guide](https://github.com/advaitpatel/DockSec/blob/main/README.md#-troubleshooting)
- [ ] [Existing issues](https://github.com/advaitpatel/DockSec/issues)
- [ ] [Examples directory](https://github.com/advaitpatel/DockSec/tree/main/examples)
75 changes: 32 additions & 43 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,55 @@
# Pull Request

## 📝 Description
## Description

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

Fixes # (issue)
Closes #

## 🎯 Type of Change
## Type of Change

Please delete options that are not relevant:
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
- [ ] Code style update (formatting, renaming)
- [ ] Code refactoring (no functional changes)
- [ ] Performance improvement
- [ ] Test update
- [ ] Build / CI configuration
- [ ] Security fix

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

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

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

- [ ] Test A
- [ ] Test B

**Test Configuration**:
**Test Configuration:**
- Python version:
- Operating System:
- DockSec version:

## 📋 Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings or errors
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published
- [ ] I have checked my code and corrected any misspellings

## 📸 Screenshots (if applicable)
## Checklist

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

## 🔗 Related Issues/PRs
## Screenshots (if applicable)

Link any related issues or pull requests:
## Related Issues / PRs

- Relates to #
- Closes #
- Depends on #

## 📚 Additional Notes

Any additional information that reviewers should know.

---

**By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.**
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -193,3 +193,6 @@ SESSION_SUMMARY.md
CURSOR_CONFIGURATION.md

# Internal/maintainer documentation (not for public repository)

# Claude Code project instructions (local only, not for public repository)
CLAUDE.md
Loading