Skip to content

Commit 2d172de

Browse files
curiouscoder-cmdcuriouscoder-cmd
committed
chore: add GitHub templates and workflows for issues, PRs, and funding
1 parent d69cb95 commit 2d172de

File tree

16 files changed

+1913
-0
lines changed

16 files changed

+1913
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# GitHub Sponsors configuration
2+
# You can add your funding platforms here
3+
4+
# github: [curiouscoder-cmd]
5+
# patreon: your-patreon
6+
# open_collective: your-collective
7+
# ko_fi: your-kofi
8+
# tidelift: npm/package-name
9+
# community_bridge: project-name
10+
# liberapay: your-liberapay
11+
# issuehunt: your-issuehunt
12+
# custom: ['https://your-custom-link.com']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve ENV Storage Manager
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+
## 📋 Steps to Reproduce
14+
15+
Steps to reproduce the behavior:
16+
17+
1. Go to '...'
18+
2. Run command '...'
19+
3. Enter input '...'
20+
4. See error
21+
22+
## ✅ Expected Behavior
23+
24+
A clear and concise description of what you expected to happen.
25+
26+
## ❌ Actual Behavior
27+
28+
A clear and concise description of what actually happened.
29+
30+
## 📸 Screenshots
31+
32+
If applicable, add screenshots to help explain your problem.
33+
34+
## 🖥️ Environment
35+
36+
Please complete the following information:
37+
38+
- **OS**: [e.g., macOS 14.0, Ubuntu 22.04, Windows 11]
39+
- **Python Version**: [e.g., 3.11.5]
40+
- **ENV Storage Version**: [e.g., 1.0.0]
41+
- **Installation Method**: [e.g., pip, source]
42+
43+
## 📝 Additional Context
44+
45+
Add any other context about the problem here.
46+
47+
### Error Messages
48+
49+
```
50+
Paste any error messages or stack traces here
51+
```
52+
53+
### Configuration
54+
55+
```yaml
56+
# If relevant, paste your configuration (remove sensitive data!)
57+
```
58+
59+
## 🔍 Possible Solution
60+
61+
If you have suggestions on how to fix the bug, please describe them here.
62+
63+
## ✅ Checklist
64+
65+
- [ ] I have searched existing issues to avoid duplicates
66+
- [ ] I have provided all requested information
67+
- [ ] I have removed any sensitive information from this report
68+
- [ ] I am using the latest version of ENV Storage Manager
69+
70+
---
71+
72+
**Note**: Please ensure you have removed any sensitive information (passwords, API keys, etc.) before submitting this issue.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/curiouscoder-cmd/ENV_Storage/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📖 Documentation
7+
url: https://github.com/curiouscoder-cmd/ENV_Storage/blob/main/README.md
8+
about: Read the project documentation
9+
- name: 🔒 Security Issue
10+
url: https://github.com/curiouscoder-cmd/ENV_Storage/security/advisories/new
11+
about: Report a security vulnerability (private)

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for ENV Storage Manager
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.
12+
13+
## 🎯 Problem Statement
14+
15+
What problem does this feature solve? Describe the use case.
16+
17+
**Example**: "I'm always frustrated when..."
18+
19+
## 💭 Proposed Solution
20+
21+
Describe how you envision this feature working.
22+
23+
## 🔄 Alternatives Considered
24+
25+
Have you considered any alternative solutions or features? Describe them here.
26+
27+
## 📊 Benefits
28+
29+
Who would benefit from this feature and how?
30+
31+
- **Users**: How does this help end users?
32+
- **Developers**: How does this help contributors?
33+
- **Project**: How does this improve the project overall?
34+
35+
## 📝 Implementation Ideas
36+
37+
If you have technical ideas on how to implement this, share them here.
38+
39+
```python
40+
# Optional: Provide code examples or pseudocode
41+
```
42+
43+
## 🎨 UI/UX Mockups
44+
45+
If applicable, add mockups, wireframes, or examples from other tools.
46+
47+
## 📚 Additional Context
48+
49+
Add any other context, screenshots, or references about the feature request here.
50+
51+
## 🏷️ Feature Category
52+
53+
Which area does this feature relate to? (Check all that apply)
54+
55+
- [ ] CLI (Command Line Interface)
56+
- [ ] GUI (Graphical User Interface)
57+
- [ ] Encryption/Security
58+
- [ ] Import/Export
59+
- [ ] Search/Filter
60+
- [ ] Project Management
61+
- [ ] Documentation
62+
- [ ] Testing
63+
- [ ] Performance
64+
- [ ] Other: ___________
65+
66+
## 🎃 Hacktoberfest
67+
68+
- [ ] I would like to work on this feature for Hacktoberfest
69+
- [ ] This is a good first issue for newcomers
70+
71+
## ✅ Checklist
72+
73+
- [ ] I have searched existing issues to avoid duplicates
74+
- [ ] I have provided a clear description of the feature
75+
- [ ] I have explained the problem this feature solves
76+
- [ ] This feature aligns with the project's goals
77+
78+
---
79+
80+
**Thank you for helping improve ENV Storage Manager!** 🚀

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
## 📝 Description
2+
3+
<!-- Provide a clear and concise description of your changes -->
4+
5+
## 🔗 Related Issue
6+
7+
<!-- Link to the issue this PR addresses -->
8+
Closes #(issue number)
9+
10+
## 🎯 Type of Change
11+
12+
<!-- Mark the relevant option with an 'x' -->
13+
14+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
15+
- [ ] ✨ New feature (non-breaking change which adds functionality)
16+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
17+
- [ ] 📝 Documentation update
18+
- [ ] 🎨 Style/UI update (formatting, renaming, etc.)
19+
- [ ] ♻️ Code refactoring (no functional changes)
20+
- [ ] ⚡ Performance improvement
21+
- [ ] ✅ Test update
22+
- [ ] 🔧 Configuration change
23+
- [ ] 🔒 Security fix
24+
25+
## 🧪 Testing
26+
27+
<!-- Describe the tests you ran and how to reproduce them -->
28+
29+
### Test Configuration
30+
31+
- **OS**: [e.g., macOS, Ubuntu, Windows]
32+
- **Python Version**: [e.g., 3.11]
33+
- **Test Framework**: [e.g., pytest]
34+
35+
### Test Results
36+
37+
```bash
38+
# Paste test output here
39+
```
40+
41+
## 📸 Screenshots (if applicable)
42+
43+
<!-- Add screenshots to demonstrate the changes -->
44+
45+
## ✅ Checklist
46+
47+
<!-- Mark completed items with an 'x' -->
48+
49+
### Code Quality
50+
51+
- [ ] My code follows the project's style guidelines
52+
- [ ] I have performed a self-review of my code
53+
- [ ] I have commented my code, particularly in hard-to-understand areas
54+
- [ ] My changes generate no new warnings
55+
- [ ] I have removed any debugging code and console logs
56+
57+
### Testing
58+
59+
- [ ] I have added tests that prove my fix is effective or that my feature works
60+
- [ ] New and existing unit tests pass locally with my changes
61+
- [ ] I have tested on multiple platforms (if applicable)
62+
63+
### Documentation
64+
65+
- [ ] I have updated the documentation accordingly
66+
- [ ] I have updated the README (if needed)
67+
- [ ] I have added/updated code comments
68+
- [ ] I have updated type hints (if applicable)
69+
70+
### Git
71+
72+
- [ ] My commits follow the project's commit message guidelines
73+
- [ ] I have rebased my branch on the latest main branch
74+
- [ ] I have resolved all merge conflicts
75+
- [ ] My branch has a descriptive name
76+
77+
### Security
78+
79+
- [ ] I have not included any sensitive information (API keys, passwords, etc.)
80+
- [ ] I have considered security implications of my changes
81+
- [ ] I have updated SECURITY.md (if applicable)
82+
83+
## 🎃 Hacktoberfest
84+
85+
<!-- If participating in Hacktoberfest, check the box below -->
86+
87+
- [ ] This PR is part of Hacktoberfest 2025
88+
- [ ] I have read and followed the [Contributing Guidelines](../CONTRIBUTING.md)
89+
- [ ] I have read and agree to the [Code of Conduct](../CODE_OF_CONDUCT.md)
90+
91+
## 📋 Additional Notes
92+
93+
<!-- Add any additional notes, context, or concerns here -->
94+
95+
### Breaking Changes
96+
97+
<!-- If this is a breaking change, describe the impact and migration path -->
98+
99+
### Dependencies
100+
101+
<!-- List any new dependencies added -->
102+
103+
### Performance Impact
104+
105+
<!-- Describe any performance implications -->
106+
107+
## 🔍 Reviewer Notes
108+
109+
<!-- Any specific areas you'd like reviewers to focus on? -->
110+
111+
---
112+
113+
**Thank you for contributing to ENV Storage Manager!** 🚀
114+
115+
<!--
116+
Before submitting:
117+
1. Ensure all checkboxes are marked
118+
2. Remove any template comments you don't need
119+
3. Add relevant labels to your PR
120+
4. Request review from maintainers
121+
-->

0 commit comments

Comments
 (0)