Skip to content

Commit 3f7a023

Browse files
ersinkocersinkoc
committed
feat: initialize ModelContextKit project structure with core components and backends
1 parent 00dfe65 commit 3f7a023

42 files changed

Lines changed: 4437 additions & 2499 deletions

Some content is hidden

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
name: Bug Report
2+
description: Report a bug or issue with ModelContextKit
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for reporting a bug! Please provide as much detail as possible to help us resolve the issue.
12+
13+
- type: checkboxes
14+
id: preflight
15+
attributes:
16+
label: Preflight Checklist
17+
description: Please verify that you've done the following before submitting this bug report.
18+
options:
19+
- label: I have searched existing issues to ensure this bug hasn't been reported already
20+
required: true
21+
- label: I am using the latest version of ModelContextKit
22+
required: true
23+
- label: I have tested with a minimal reproduction case
24+
required: false
25+
26+
- type: input
27+
id: version
28+
attributes:
29+
label: ModelContextKit Version
30+
description: What version of ModelContextKit are you using?
31+
placeholder: "0.1.2"
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
id: backend
37+
attributes:
38+
label: Backend Type
39+
description: Which backend were you using when the bug occurred?
40+
options:
41+
- Database
42+
- API
43+
- Filesystem
44+
- Web Scraper
45+
- Email
46+
- Cloud Storage
47+
- Not applicable
48+
- Other (specify in description)
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: description
54+
attributes:
55+
label: Bug Description
56+
description: Provide a clear and concise description of the bug.
57+
placeholder: "What happened? What did you expect to happen?"
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: reproduction
63+
attributes:
64+
label: Steps to Reproduce
65+
description: Provide step-by-step instructions to reproduce the bug.
66+
placeholder: |
67+
1. Run command: `modelctx create my-server --backend database`
68+
2. Configure with: ...
69+
3. Execute: ...
70+
4. Observe error: ...
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: expected
76+
attributes:
77+
label: Expected Behavior
78+
description: What should have happened instead?
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
id: generated-code
84+
attributes:
85+
label: Generated Code (if applicable)
86+
description: If the bug involves generated code, please include the problematic code snippet.
87+
render: python
88+
89+
- type: textarea
90+
id: error-output
91+
attributes:
92+
label: Error Output
93+
description: Include any error messages, stack traces, or relevant output.
94+
render: shell
95+
96+
- type: textarea
97+
id: environment
98+
attributes:
99+
label: Environment Information
100+
description: Provide details about your environment.
101+
placeholder: |
102+
- OS: [e.g., Ubuntu 20.04, Windows 10, macOS 12]
103+
- Python: [e.g., 3.9.0]
104+
- Shell: [e.g., bash, PowerShell]
105+
- Terminal: [e.g., Terminal, VS Code]
106+
validations:
107+
required: true
108+
109+
- type: textarea
110+
id: additional
111+
attributes:
112+
label: Additional Context
113+
description: Add any other context, screenshots, or information about the problem.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for ModelContextKit
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for suggesting a new feature! Please provide detailed information to help us understand your request.
12+
13+
- type: checkboxes
14+
id: preflight
15+
attributes:
16+
label: Preflight Checklist
17+
description: Please verify that you've done the following before submitting this feature request.
18+
options:
19+
- label: I have searched existing issues to ensure this feature hasn't been requested already
20+
required: true
21+
- label: I have checked the documentation to ensure this feature doesn't already exist
22+
required: true
23+
24+
- type: dropdown
25+
id: category
26+
attributes:
27+
label: Feature Category
28+
description: What type of feature are you requesting?
29+
options:
30+
- New Backend Type
31+
- CLI Enhancement
32+
- Template Improvement
33+
- Documentation
34+
- Testing
35+
- Security
36+
- Performance
37+
- Developer Experience
38+
- Other (specify in description)
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: summary
44+
attributes:
45+
label: Feature Summary
46+
description: Provide a clear and concise summary of the feature you'd like to see.
47+
placeholder: "I would like ModelContextKit to support..."
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: problem
53+
attributes:
54+
label: Problem Statement
55+
description: What problem does this feature solve? What use case does it enable?
56+
placeholder: "This feature would solve the problem of..."
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: solution
62+
attributes:
63+
label: Proposed Solution
64+
description: Describe how you envision this feature working.
65+
placeholder: "The feature should work by..."
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: alternatives
71+
attributes:
72+
label: Alternatives Considered
73+
description: Have you considered any alternative approaches or workarounds?
74+
placeholder: "I considered these alternatives..."
75+
76+
- type: textarea
77+
id: examples
78+
attributes:
79+
label: Usage Examples
80+
description: Provide examples of how this feature would be used.
81+
placeholder: |
82+
```bash
83+
# Example command usage
84+
modelctx create my-server --backend new-backend-type
85+
```
86+
render: markdown
87+
88+
- type: dropdown
89+
id: priority
90+
attributes:
91+
label: Priority
92+
description: How important is this feature to you?
93+
options:
94+
- Low - Nice to have
95+
- Medium - Would improve my workflow
96+
- High - Essential for my use case
97+
- Critical - Blocking my project
98+
validations:
99+
required: true
100+
101+
- type: checkboxes
102+
id: implementation
103+
attributes:
104+
label: Implementation Willingness
105+
description: Are you willing to help implement this feature?
106+
options:
107+
- label: I'm willing to submit a pull request for this feature
108+
- label: I can help with testing and feedback
109+
- label: I can help with documentation
110+
- label: I can provide additional requirements and use cases
111+
112+
- type: textarea
113+
id: additional
114+
attributes:
115+
label: Additional Context
116+
description: Add any other context, mockups, or information about the feature request.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Brief description of the changes in this PR.
6+
7+
## Type of Change
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Code quality improvement
14+
- [ ] Performance improvement
15+
- [ ] Security improvement
16+
17+
## Related Issues
18+
19+
Fixes #(issue number)
20+
Relates to #(issue number)
21+
22+
## Changes Made
23+
24+
- [ ] Added/modified backend: [backend name]
25+
- [ ] Updated templates
26+
- [ ] Modified CLI commands
27+
- [ ] Updated documentation
28+
- [ ] Added/updated tests
29+
- [ ] Fixed code generation issues
30+
31+
## Testing
32+
33+
### Manual Testing
34+
35+
- [ ] Tested code generation for affected backends
36+
- [ ] Verified generated code compiles without errors
37+
- [ ] Tested CLI commands work as expected
38+
- [ ] Verified generated servers follow MCP protocol
39+
40+
### Automated Testing
41+
42+
- [ ] All existing tests pass
43+
- [ ] Added tests for new functionality
44+
- [ ] Generated code passes syntax validation
45+
- [ ] Integration tests pass
46+
47+
### Backend-Specific Testing (if applicable)
48+
49+
- [ ] **Database**: Generated server connects and executes queries
50+
- [ ] **API**: Generated server makes HTTP requests correctly
51+
- [ ] **Filesystem**: Generated server handles file operations safely
52+
- [ ] **Webscraper**: Generated server respects robots.txt and rate limits
53+
- [ ] **Email**: Generated server sends/receives emails correctly
54+
- [ ] **Cloud Storage**: Generated server interacts with cloud APIs
55+
56+
## Code Quality
57+
58+
- [ ] Code follows project style guidelines
59+
- [ ] Code is properly documented (docstrings, comments)
60+
- [ ] No hard-coded values or secrets
61+
- [ ] Error handling is appropriate
62+
- [ ] Generated code is readable and maintainable
63+
64+
## Breaking Changes
65+
66+
If this PR introduces breaking changes, describe them here:
67+
68+
- [ ] No breaking changes
69+
- [ ] Breaking changes described below:
70+
71+
[Describe breaking changes and migration steps]
72+
73+
## Screenshots/Output (if applicable)
74+
75+
```
76+
Include relevant command output, screenshots, or generated code examples
77+
```
78+
79+
## Checklist
80+
81+
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
82+
- [ ] My code follows the project's style guidelines
83+
- [ ] I have performed a self-review of my code
84+
- [ ] I have commented my code, particularly in hard-to-understand areas
85+
- [ ] I have made corresponding changes to the documentation
86+
- [ ] My changes generate no new warnings
87+
- [ ] I have added tests that prove my fix is effective or that my feature works
88+
- [ ] New and existing unit tests pass locally with my changes
89+
- [ ] Any dependent changes have been merged and published in downstream modules
90+
91+
## Generated Code Validation
92+
93+
For changes affecting code generation, please verify:
94+
95+
- [ ] Generated code compiles without syntax errors
96+
- [ ] Generated code follows MCP protocol specifications
97+
- [ ] Generated code includes proper error handling
98+
- [ ] Generated code has appropriate security measures
99+
- [ ] Generated tests pass
100+
101+
## Documentation Updates
102+
103+
- [ ] README.md updated (if needed)
104+
- [ ] CHANGELOG.md updated
105+
- [ ] API documentation updated (if needed)
106+
- [ ] Examples updated (if needed)
107+
108+
## Deployment Considerations
109+
110+
- [ ] No deployment considerations
111+
- [ ] Database migrations required
112+
- [ ] Configuration changes required
113+
- [ ] Dependencies updated
114+
115+
## Additional Notes
116+
117+
Add any additional notes, concerns, or discussion points for reviewers.

0 commit comments

Comments
 (0)