Skip to content

Commit ddf7c42

Browse files
thegdsksthegdsks
authored
Merge pull request #3 from GLINCKER/develop
feat: add comprehensive open source project structure
2 parents c96e489 + 7279bfd commit ddf7c42

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+11889
-393
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve CommitWeave
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## 🐛 Bug Description
11+
A clear and concise description of what the bug is.
12+
13+
## 🔄 Steps to Reproduce
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
## ✅ Expected Behavior
21+
A clear and concise description of what you expected to happen.
22+
23+
## ❌ Actual Behavior
24+
A clear and concise description of what actually happened.
25+
26+
## 📱 Environment
27+
**Please complete the following information:**
28+
- **OS**: [e.g. Windows 11, macOS 13, Ubuntu 22.04]
29+
- **Node.js Version**: [run `node --version`]
30+
- **CommitWeave Version**: [run `commitweave --version`]
31+
- **VS Code Version**: [if using the extension]
32+
- **Git Version**: [run `git --version`]
33+
34+
## 📋 Additional Context
35+
**Configuration Files** (please remove any API keys):
36+
```json
37+
// Contents of your commitweave config file (if any)
38+
```
39+
40+
**Error Messages/Stack Traces**:
41+
```
42+
Paste any error messages or stack traces here
43+
```
44+
45+
**Screenshots**:
46+
If applicable, add screenshots to help explain your problem.
47+
48+
## 🔍 Attempted Solutions
49+
What have you tried to fix this issue?
50+
- [ ] Checked documentation
51+
- [ ] Updated to latest version
52+
- [ ] Cleared configuration/cache
53+
- [ ] Other: ___________
54+
55+
## 📊 Impact
56+
How does this bug affect your workflow?
57+
- [ ] Blocks all usage
58+
- [ ] Prevents specific features from working
59+
- [ ] Minor inconvenience
60+
- [ ] Cosmetic issue
61+
62+
---
63+
64+
**Thank you for helping improve CommitWeave! 🧶✨**

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for CommitWeave
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## 💡 Feature Description
11+
A clear and concise description of what you want to happen.
12+
13+
## 🎯 Problem Statement
14+
What problem does this feature solve? Is your feature request related to a problem?
15+
*Example: "I'm always frustrated when [...]"*
16+
17+
## 💭 Proposed Solution
18+
Describe the solution you'd like to see implemented.
19+
20+
## 🔄 Alternative Solutions
21+
Describe any alternative solutions or features you've considered.
22+
23+
## 📋 Use Cases
24+
Who would benefit from this feature? Describe specific use cases:
25+
26+
1. **Developer Type**: [e.g. Frontend, Backend, DevOps]
27+
2. **Scenario**: [e.g. Working on large teams, Solo projects, CI/CD integration]
28+
3. **Current Workflow**: [How do you currently handle this?]
29+
4. **Improved Workflow**: [How would this feature improve it?]
30+
31+
## 🛠️ Implementation Ideas
32+
Do you have any thoughts on how this could be implemented?
33+
- [ ] CLI command enhancement
34+
- [ ] VS Code extension feature
35+
- [ ] Configuration option
36+
- [ ] AI integration improvement
37+
- [ ] Other: ___________
38+
39+
## 📊 Priority
40+
How important is this feature to you?
41+
- [ ] Critical - Blocks my workflow
42+
- [ ] High - Would significantly improve my experience
43+
- [ ] Medium - Nice to have
44+
- [ ] Low - Minor improvement
45+
46+
## 🎨 Mockups/Examples
47+
If applicable, add mockups, examples, or references to similar features in other tools.
48+
49+
## 🔗 Related Issues
50+
Are there any related issues or PRs?
51+
- Related to #___
52+
- Blocks #___
53+
- Depends on #___
54+
55+
## 📝 Additional Context
56+
Add any other context, screenshots, or examples about the feature request here.
57+
58+
---
59+
60+
**Thanks for helping make CommitWeave better! 🧶✨**

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Question or Help
3+
about: Ask a question about CommitWeave usage or configuration
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
## ❓ Question
11+
What would you like to know about CommitWeave?
12+
13+
## 🎯 What Are You Trying to Achieve?
14+
Describe what you're trying to accomplish with CommitWeave.
15+
16+
## 🔄 What Have You Tried?
17+
What steps have you already taken or what documentation have you checked?
18+
- [ ] Read the README
19+
- [ ] Checked the documentation
20+
- [ ] Searched existing issues
21+
- [ ] Tried different configurations
22+
- [ ] Asked in discussions
23+
24+
## 📱 Your Setup
25+
**Please provide relevant information about your setup:**
26+
- **OS**: [e.g. Windows 11, macOS 13, Ubuntu 22.04]
27+
- **Node.js Version**: [run `node --version`]
28+
- **CommitWeave Version**: [run `commitweave --version`]
29+
- **Installation Method**: [npm, yarn, npx, VS Code extension]
30+
31+
## 📋 Configuration
32+
If relevant, please share your configuration (remove any API keys):
33+
```json
34+
// Your commitweave config here
35+
```
36+
37+
## 📝 Additional Context
38+
Any additional context, screenshots, or examples that might help us understand your question.
39+
40+
## 🚀 Expected Outcome
41+
What kind of answer or solution would be most helpful to you?
42+
43+
---
44+
45+
**We're here to help! 🧶✨**

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Pull Request
2+
3+
## 📋 Summary
4+
Brief description of what this PR does and why it's needed.
5+
6+
## 🎯 Type of Change
7+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
8+
- [ ] ✨ New feature (non-breaking change which adds functionality)
9+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] 📚 Documentation update
11+
- [ ] 🧪 Test improvements
12+
- [ ] 🔧 Refactoring (no functional changes)
13+
- [ ] 🔒 Security improvement
14+
- [ ] ⚡ Performance improvement
15+
- [ ] 🎨 Style/UI changes
16+
17+
## 🔄 Changes Made
18+
<!-- Describe the changes in detail -->
19+
20+
### Added
21+
-
22+
23+
### Changed
24+
-
25+
26+
### Fixed
27+
-
28+
29+
### Removed
30+
-
31+
32+
## 🧪 Testing
33+
<!-- Describe how you tested these changes -->
34+
35+
- [ ] Unit tests pass (`npm test`)
36+
- [ ] Integration tests pass
37+
- [ ] Manual testing completed
38+
- [ ] VS Code extension tested (if applicable)
39+
- [ ] Cross-platform testing (Windows/macOS/Linux)
40+
41+
### Test Cases
42+
1. **Scenario**:
43+
- **Steps**:
44+
- **Expected**:
45+
- **Result**: ✅/❌
46+
47+
## 📱 Environment Tested
48+
- [ ] **OS**: Windows / macOS / Linux
49+
- [ ] **Node.js**: v18 / v20 / v21
50+
- [ ] **VS Code**: Latest version (if extension changes)
51+
52+
## 🔗 Related Issues
53+
<!-- Link any related issues -->
54+
- Closes #___
55+
- Fixes #___
56+
- Related to #___
57+
58+
## 📸 Screenshots/Examples
59+
<!-- If applicable, add screenshots or code examples -->
60+
61+
### Before
62+
```
63+
<!-- Show the old behavior -->
64+
```
65+
66+
### After
67+
```
68+
<!-- Show the new behavior -->
69+
```
70+
71+
## 📋 Checklist
72+
<!-- Check all that apply -->
73+
74+
### Code Quality
75+
- [ ] My code follows the project's style guidelines
76+
- [ ] I have performed a self-review of my own code
77+
- [ ] I have commented my code, particularly in hard-to-understand areas
78+
- [ ] My changes generate no new warnings or errors
79+
80+
### Testing
81+
- [ ] I have added tests that prove my fix is effective or that my feature works
82+
- [ ] New and existing unit tests pass locally with my changes
83+
- [ ] I have tested the VS Code extension manually (if applicable)
84+
85+
### Documentation
86+
- [ ] I have made corresponding changes to the documentation
87+
- [ ] I have updated the CHANGELOG.md (if applicable)
88+
- [ ] My changes don't break existing API contracts
89+
90+
### Dependencies & Performance
91+
- [ ] I have considered the impact on bundle size
92+
- [ ] I have tested startup performance impact
93+
- [ ] No new dependencies added without justification
94+
95+
## 🚨 Breaking Changes
96+
<!-- If this introduces breaking changes, describe them here -->
97+
- [ ] This PR introduces breaking changes
98+
- [ ] Migration guide provided (if breaking changes)
99+
100+
## 🔮 Future Considerations
101+
<!-- Any follow-up work or considerations for future PRs -->
102+
103+
---
104+
105+
## 📝 Notes for Reviewers
106+
<!-- Any specific areas you'd like reviewers to focus on -->
107+
108+
**Priority**: High / Medium / Low
109+
**Review Focus**: Logic / Performance / Security / UX / Documentation
110+
111+
---
112+
113+
**Ready for review! 🧶✨**
114+
115+
<!--
116+
Thank you for contributing to CommitWeave!
117+
Your PR helps make git commits better for developers everywhere.
118+
-->

‎.github/workflows/ci.yml

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,55 @@ jobs:
4949
- name: Test package installation
5050
run: |
5151
npm pack --dry-run
52-
echo "Package structure verified"
52+
echo "Package structure verified"
53+
54+
vscode-extension:
55+
runs-on: ubuntu-latest
56+
57+
steps:
58+
- name: Checkout code
59+
uses: actions/checkout@v4
60+
61+
- name: Setup Node.js 20
62+
uses: actions/setup-node@v4
63+
with:
64+
node-version: 20
65+
cache: 'npm'
66+
67+
- name: Install extension dependencies
68+
run: |
69+
cd vscode-extension
70+
npm ci
71+
72+
- name: Build VS Code extension
73+
run: |
74+
cd vscode-extension
75+
npm run build
76+
77+
- name: Lint extension code
78+
run: |
79+
cd vscode-extension
80+
npx tsc --noEmit
81+
82+
- name: Run extension tests
83+
run: |
84+
cd vscode-extension
85+
xvfb-run -a npm test
86+
87+
- name: Package VSIX
88+
run: |
89+
cd vscode-extension
90+
npx vsce package --no-yarn
91+
92+
- name: Upload VSIX artifact
93+
uses: actions/upload-artifact@v4
94+
with:
95+
name: commitweave-vscode-extension
96+
path: vscode-extension/*.vsix
97+
retention-days: 30
98+
99+
- name: Test VSIX structure
100+
run: |
101+
cd vscode-extension
102+
ls -la *.vsix
103+
echo "VSIX package created successfully"

0 commit comments

Comments
 (0)