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
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: 🐛 Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!

- type: textarea
id: bug-description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is
placeholder: When I run X command, Y happens instead of Z...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Run command '...'
2. With input '...'
3. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: The command should have...
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating System
description: What OS are you using?
options:
- macOS
- Linux
- Windows
validations:
required: true

- type: input
id: python-version
attributes:
label: Python Version
description: What version of Python are you using?
placeholder: e.g., 3.9.6
validations:
required: true

- type: input
id: helm-version
attributes:
label: Helm Version
description: What version of Helm are you using?
placeholder: e.g., 3.12.0
validations:
required: true

- type: input
id: package-version
attributes:
label: Package Version
description: What version of helm-values-manager are you using?
placeholder: e.g., 0.1.0
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant Log Output
description: Please copy and paste any relevant log output
render: shell

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Questions & Discussions
url: https://github.com/zipstack/helm-values-manager/discussions
about: Please ask and answer questions here.
- name: 📖 Documentation
url: https://github.com/zipstack/helm-values-manager/tree/main/docs
about: Check our documentation before creating an issue.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: 📚 Documentation
description: Suggest improvements or report issues in documentation
title: "[Docs]: "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Thanks for helping us improve our documentation!

- type: dropdown
id: doc-type
attributes:
label: Documentation Type
description: What type of documentation needs attention?
options:
- README
- API Documentation
- Installation Guide
- Usage Examples
- Architecture/Design Docs
- Contributing Guide
- Other
validations:
required: true

- type: textarea
id: current-issue
attributes:
label: Current Documentation Issue
description: What's missing, unclear, or incorrect in the current documentation?
placeholder: The current documentation lacks information about...
validations:
required: true

- type: textarea
id: suggested-changes
attributes:
label: Suggested Changes
description: Describe your suggested changes or additions
placeholder: |
The documentation should include:
1. ...
2. ...
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I've checked that this isn't already documented somewhere else
required: true
- label: I've provided specific suggestions for improvement
required: true
- label: I've included examples where relevant
required: false

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the documentation request here
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: ✨ Feature Request
description: Suggest an idea for this project
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature!

- type: textarea
id: problem
attributes:
label: Problem Statement
description: Is your feature request related to a problem? Please describe.
placeholder: I'm always frustrated when [...]
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like
placeholder: |
A clear and concise description of what you want to happen.
Include any specific implementation details you have in mind.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternative Solutions
description: Describe alternatives you've considered
placeholder: What other approaches could solve this problem?
validations:
required: false

- type: checkboxes
id: requirements
attributes:
label: Requirements
description: Please confirm these requirements
options:
- label: This feature aligns with the project's scope and goals
required: true
- label: I've checked that this feature doesn't already exist
required: true
- label: I've searched for existing feature requests
required: true

- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: List the requirements that should be met
placeholder: |
- [ ] Feature does X when Y
- [ ] Handles error case Z
- [ ] Documentation updated
- [ ] Tests added
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the feature request here
47 changes: 47 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Related Issues
<!-- List any related issues this PR addresses using #issue-number -->
Fixes #

## Changes Made
<!-- Describe the changes you've made -->
-
-
-

## Testing Done
<!-- Describe the testing you've performed -->
- [ ] Added unit tests
- [ ] Added integration tests
- [ ] Manually tested
- [ ] Updated test documentation

## Checklist
<!-- Please check all that apply -->
- [ ] I have read the CONTRIBUTING guidelines
- [ ] My code follows the project's style guidelines
- [ ] I have added tests that prove my fix/feature works
- [ ] I have updated the documentation accordingly
- [ ] All new and existing tests passed
- [ ] My commits follow the project's commit message convention

## Type of Change
<!-- What type of change does this PR introduce? -->
- [ ] Feature
- [ ] Bug Fix
- [ ] Documentation
- [ ] Performance Improvement
- [ ] Code Style Update
- [ ] Refactoring
- [ ] CI/CD
- [ ] Other

## Breaking Change
<!-- Does this PR introduce a breaking change? -->
- [ ] No
- [ ] Yes (please describe below)

### Breaking Change Description
<!-- If this PR introduces a breaking change, describe it and migration steps -->

## Additional Information
<!-- Add any other context about the PR here -->
101 changes: 101 additions & 0 deletions .github/pull_request_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
name: Pull Request
description: Create a pull request
title: "[PR]: "
body:
- type: markdown
attributes:
value: |
Thanks for creating this pull request! Please ensure you've read our contributing guidelines.

- type: input
id: related-issues
attributes:
label: Related Issues
description: List any related issues this PR addresses
placeholder: "#123, #456"
validations:
required: true

- type: textarea
id: changes
attributes:
label: Changes Made
description: Describe the changes you've made
placeholder: |
- Added feature X
- Fixed bug Y
- Updated documentation for Z
validations:
required: true

- type: textarea
id: testing
attributes:
label: Testing Done
description: Describe the testing you've performed
placeholder: |
- Added unit tests for X
- Added integration tests for Y
- Manually tested scenario Z
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Pull Request Checklist
description: Please check all that apply
options:
- label: I have read the CONTRIBUTING guidelines
required: true
- label: My code follows the project's style guidelines
required: true
- label: I have added tests that prove my fix/feature works
required: true
- label: I have updated the documentation accordingly
required: true
- label: All new and existing tests passed
required: true
- label: My commits follow the project's commit message convention
required: true

- type: dropdown
id: type
attributes:
label: Type of Change
description: What type of change does this PR introduce?
options:
- Feature
- Bug Fix
- Documentation
- Performance Improvement
- Code Style Update
- Refactoring
- CI/CD
- Other
validations:
required: true

- type: dropdown
id: breaking
attributes:
label: Breaking Change
description: Does this PR introduce a breaking change?
options:
- "No"
- "Yes"
validations:
required: true

- type: textarea
id: breaking-description
attributes:
label: Breaking Change Description
description: If this PR introduces a breaking change, describe it and migration steps
placeholder: Describe the breaking changes and how to migrate...

- type: textarea
id: additional
attributes:
label: Additional Information
description: Add any other context about the PR here
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,6 @@ bin/
.DS_Store
.AppleDouble
.LSOverride

# windsurf rules
.windsurfrules
Loading