-
-
Notifications
You must be signed in to change notification settings - Fork 24
refactor: prepare project for open source release #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
CONTRIBUTING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Contributing to CodeRunner | ||
|
|
||
| Thank you for your interest in contributing to CodeRunner! We welcome contributions from the community. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Fork the repository | ||
| 2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/coderunner.git` | ||
| 3. Create a new branch: `git checkout -b feature/your-feature-name` | ||
| 4. Make your changes | ||
| 5. Test your changes thoroughly | ||
| 6. Commit your changes: `git commit -m "Add your feature"` | ||
| 7. Push to your fork: `git push origin feature/your-feature-name` | ||
| 8. Create a Pull Request | ||
|
|
||
| ## Development Setup | ||
|
|
||
| 1. Install dependencies: `pip install -r requirements.txt` | ||
| 2. Copy the example config: `cp claude_mcp_proxy/claude_desktop_config.example.json claude_mcp_proxy/claude_desktop_config.json` | ||
| 3. Update the config file with your local paths | ||
| 4. Follow the setup instructions in the README | ||
|
|
||
| ## Code Style | ||
|
|
||
| - Follow PEP 8 for Python code | ||
| - Use meaningful variable and function names | ||
| - Add comments for complex logic | ||
| - Write tests for new features | ||
|
|
||
| ## Testing | ||
|
|
||
| - Ensure all existing tests pass | ||
| - Add tests for new functionality | ||
| - Test with different Python versions if possible | ||
|
|
||
| ## Submitting Changes | ||
|
|
||
| - Keep commits focused and atomic | ||
| - Write clear commit messages | ||
| - Update documentation as needed | ||
| - Ensure no sensitive information is included | ||
|
|
||
| ## Questions? | ||
|
|
||
| Feel free to open an issue for questions or discussions about contributing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
LICENSE
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 CodeRunner | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
claude_mcp_proxy/claude_desktop_config.example.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "mcpServers": { | ||
| "coderunner": { | ||
| "command": "/path/to/your/python", | ||
| "args": [ | ||
| "/path/to/coderunner/claude_mcp_proxy/mcp.py" | ||
| ] | ||
| }, | ||
| "filesystem": { | ||
| "command": "/path/to/your/node", | ||
| "args": [ | ||
| "/path/to/mcp/filesystem/server", | ||
| "/path/to/workspace1", | ||
| "/path/to/workspace2" | ||
| ] | ||
| } | ||
| } | ||
| } |
18 changes: 0 additions & 18 deletions
claude_mcp_proxy/claude_desktop_config.json
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.