Skip to content

Commit 19091b0

Browse files
eliezedeckeliezedeck
committed
CI/CD and README.md update to make the project open-source
1 parent 57f14b7 commit 19091b0

File tree

15 files changed

+1737
-284
lines changed

15 files changed

+1737
-284
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: Bug Report
2+
description: File a bug report to help us improve Sidekick
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
13+
- type: input
14+
id: version
15+
attributes:
16+
label: Sidekick Version
17+
description: What version of Sidekick are you running?
18+
placeholder: e.g., v0.1.0
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: os
24+
attributes:
25+
label: Operating System
26+
description: What operating system are you using?
27+
options:
28+
- macOS (Intel)
29+
- macOS (Apple Silicon)
30+
- Linux (x86_64)
31+
- Linux (ARM64)
32+
- Windows
33+
- Other (please specify in description)
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: go-version
39+
attributes:
40+
label: Go Version
41+
description: What version of Go are you using? (if building from source)
42+
placeholder: e.g., go1.23.4
43+
44+
- type: input
45+
id: claude-version
46+
attributes:
47+
label: Claude Code Version
48+
description: What version of Claude Code are you using?
49+
placeholder: e.g., 1.2.3
50+
51+
- type: textarea
52+
id: what-happened
53+
attributes:
54+
label: What happened?
55+
description: A clear and concise description of what the bug is.
56+
placeholder: Tell us what you see!
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: expected-behavior
62+
attributes:
63+
label: Expected Behavior
64+
description: A clear and concise description of what you expected to happen.
65+
placeholder: What should have happened instead?
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: steps-to-reproduce
71+
attributes:
72+
label: Steps to Reproduce
73+
description: Steps to reproduce the behavior
74+
placeholder: |
75+
1. Configure Sidekick with '...'
76+
2. Run command '...'
77+
3. See error
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: logs
83+
attributes:
84+
label: Relevant Logs
85+
description: Please copy and paste any relevant log output. This will be automatically formatted into code.
86+
render: shell
87+
88+
- type: textarea
89+
id: mcp-config
90+
attributes:
91+
label: MCP Configuration
92+
description: Your Claude Code MCP configuration (remove any sensitive information)
93+
render: json
94+
95+
- type: textarea
96+
id: additional-context
97+
attributes:
98+
label: Additional Context
99+
description: Add any other context about the problem here.
100+
101+
- type: checkboxes
102+
id: terms
103+
attributes:
104+
label: Pre-submission Checklist
105+
description: By submitting this issue, you agree that
106+
options:
107+
- label: I have searched existing issues to avoid duplicates
108+
required: true
109+
- label: I have provided all requested information
110+
required: true
111+
- label: This is not a security vulnerability (use SECURITY.md for those)
112+
required: true

‎.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: false
2+
contact_links:
3+
- name: 💬 Ask a Question
4+
url: https://github.com/eliezedeck/AIDevTools/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 🔒 Security Vulnerability
7+
url: https://github.com/eliezedeck/AIDevTools/security/advisories/new
8+
about: Report security vulnerabilities privately
9+
- name: 📚 Documentation
10+
url: https://github.com/eliezedeck/AIDevTools#readme
11+
about: Check the documentation for setup and usage guides

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Feature Request
2+
description: Suggest an idea for Sidekick
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for suggesting a new feature for Sidekick!
12+
13+
- type: textarea
14+
id: problem
15+
attributes:
16+
label: Problem Description
17+
description: Is your feature request related to a problem? Please describe.
18+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed Solution
26+
description: Describe the solution you'd like
27+
placeholder: A clear and concise description of what you want to happen.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternatives Considered
35+
description: Describe any alternative solutions or features you've considered
36+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
37+
38+
- type: dropdown
39+
id: component
40+
attributes:
41+
label: Component
42+
description: Which component would this feature affect?
43+
options:
44+
- Process Management
45+
- Audio Notifications
46+
- MCP Integration
47+
- Installation/Setup
48+
- Documentation
49+
- CI/CD
50+
- Other
51+
52+
- type: dropdown
53+
id: priority
54+
attributes:
55+
label: Priority
56+
description: How important is this feature to you?
57+
options:
58+
- Low - Nice to have
59+
- Medium - Would significantly improve my workflow
60+
- High - Blocking my usage of Sidekick
61+
default: 1
62+
63+
- type: textarea
64+
id: use-case
65+
attributes:
66+
label: Use Case
67+
description: Describe your specific use case for this feature
68+
placeholder: |
69+
Example:
70+
- I'm building AI agents that need to...
71+
- When working with long-running processes, I need to...
72+
- For my deployment pipeline, I require...
73+
74+
- type: textarea
75+
id: additional-context
76+
attributes:
77+
label: Additional Context
78+
description: Add any other context, screenshots, or examples about the feature request here.
79+
80+
- type: checkboxes
81+
id: terms
82+
attributes:
83+
label: Pre-submission Checklist
84+
description: By submitting this feature request, you confirm that
85+
options:
86+
- label: I have searched existing issues to avoid duplicates
87+
required: true
88+
- label: This feature aligns with Sidekick's goals (MCP server for AI agents)
89+
required: true
90+
- label: I have provided sufficient detail for implementation consideration
91+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Pull Request
2+
3+
## Summary
4+
5+
Brief description of the changes in this PR.
6+
7+
## Type of Change
8+
9+
Please check the type of change your PR introduces:
10+
11+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
12+
- [ ] ✨ New feature (non-breaking change that adds functionality)
13+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
14+
- [ ] 📚 Documentation update (changes to documentation only)
15+
- [ ] 🔧 Refactoring (code changes that neither fix a bug nor add a feature)
16+
- [ ] ⚡ Performance improvement
17+
- [ ] 🧪 Test addition or improvement
18+
- [ ] 🚀 CI/CD or build process changes
19+
20+
## Related Issues
21+
22+
Closes #(issue number)
23+
Related to #(issue number)
24+
25+
## Changes Made
26+
27+
- Change 1
28+
- Change 2
29+
- Change 3
30+
31+
## Testing
32+
33+
### Automated Testing
34+
- [ ] All existing tests pass
35+
- [ ] New tests added for new functionality
36+
- [ ] Test coverage maintained or improved
37+
38+
### Manual Testing
39+
- [ ] Tested on macOS
40+
- [ ] Tested on Linux
41+
- [ ] Tested on Windows (if applicable)
42+
- [ ] Tested with Claude Code integration
43+
- [ ] Audio notifications work (macOS only)
44+
- [ ] Process management functions correctly
45+
46+
### Test Cases
47+
48+
Describe any specific test cases you ran:
49+
50+
1. Test case 1
51+
2. Test case 2
52+
53+
## Performance Impact
54+
55+
- [ ] No performance impact
56+
- [ ] Performance improvement (describe below)
57+
- [ ] Potential performance regression (describe below)
58+
59+
Performance details:
60+
61+
## Breaking Changes
62+
63+
- [ ] No breaking changes
64+
- [ ] Breaking changes (describe below and update docs)
65+
66+
Breaking change details:
67+
68+
## Documentation
69+
70+
- [ ] Documentation is up to date
71+
- [ ] README.md updated (if needed)
72+
- [ ] CONTRIBUTING.md updated (if needed)
73+
- [ ] Code comments added/updated
74+
75+
## Security Considerations
76+
77+
- [ ] No security implications
78+
- [ ] Security implications addressed (describe below)
79+
80+
Security details:
81+
82+
## Dependencies
83+
84+
- [ ] No new dependencies
85+
- [ ] New dependencies added (list below)
86+
- [ ] Dependencies updated (list below)
87+
88+
Dependency changes:
89+
90+
## Checklist
91+
92+
### Code Quality
93+
- [ ] Code follows the project's style guidelines
94+
- [ ] Self-review of code completed
95+
- [ ] Code is properly commented
96+
- [ ] No TODO comments left in production code
97+
98+
### Functionality
99+
- [ ] Changes are backwards compatible
100+
- [ ] Error handling is appropriate
101+
- [ ] Memory management is proper (no leaks)
102+
- [ ] Process cleanup works correctly
103+
104+
### Integration
105+
- [ ] MCP protocol compliance maintained
106+
- [ ] Claude Code integration works
107+
- [ ] Cross-platform compatibility preserved
108+
109+
## Additional Notes
110+
111+
Any additional information that reviewers should know:
112+
113+
---
114+
115+
## For Reviewers
116+
117+
### Review Focus Areas
118+
Please pay special attention to:
119+
- [ ] Security implications
120+
- [ ] Performance impact
121+
- [ ] Cross-platform compatibility
122+
- [ ] MCP protocol compliance
123+
124+
### Review Checklist
125+
- [ ] Code review completed
126+
- [ ] Testing verified
127+
- [ ] Documentation reviewed
128+
- [ ] Security considerations addressed

‎.github/dependabot.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
version: 2
2+
updates:
3+
# Enable version updates for Go modules
4+
- package-ecosystem: "gomod"
5+
directory: "/sidekick"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
time: "09:00"
10+
open-pull-requests-limit: 5
11+
reviewers:
12+
- "eliezedeck"
13+
assignees:
14+
- "eliezedeck"
15+
commit-message:
16+
prefix: "deps"
17+
include: "scope"
18+
labels:
19+
- "dependencies"
20+
- "go"
21+
22+
# Enable version updates for GitHub Actions
23+
- package-ecosystem: "github-actions"
24+
directory: "/"
25+
schedule:
26+
interval: "weekly"
27+
day: "monday"
28+
time: "09:00"
29+
open-pull-requests-limit: 3
30+
reviewers:
31+
- "eliezedeck"
32+
assignees:
33+
- "eliezedeck"
34+
commit-message:
35+
prefix: "ci"
36+
include: "scope"
37+
labels:
38+
- "dependencies"
39+
- "github-actions"

0 commit comments

Comments
 (0)