Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (51 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 1.95 KB

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/instavm/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 examples/requirements.txt
  2. Copy the example config: cp examples/claude_desktop/claude_desktop_config.example.json examples/claude_desktop/claude_desktop_config.json
  3. Update the config file with your local paths
  4. Follow the setup instructions in the README

Build

Build Instructions

To start building the container, you might need to perform the following commands:

# Stop any running container services
sudo pkill -f container

# Start the container system
container system start

# Remove existing buildkit if necessary
container rm buildkit

# Build the container with the specified Dockerfile and tag
container build --tag cr --file Dockerfile .

# Tag the newly built container
container images tag cr instavm/coderunner

# Push the image to the registry
container images push instavm/coderunner

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.