mirror of
https://github.com/instavm/open-skills.git
synced 2026-11-18 18:03:45 +00:00
2.0 KiB
2.0 KiB
Contributing to Open-Skills
Thank you for your interest in contributing to Open-Skills! We welcome contributions from the community.
Getting Started
- Fork the repository
- Clone your fork:
git clone https://github.com/BandarLabs/open-skills.git - Create a new branch:
git checkout -b feature/your-feature-name - Make your changes
- Test your changes thoroughly
- Commit your changes:
git commit -m "Add your feature" - Push to your fork:
git push origin feature/your-feature-name - Create a Pull Request
Development Setup
- Install dependencies:
pip install -r examples/requirements.txt - Copy the example config:
cp examples/claude_desktop/claude_desktop_config.example.json examples/claude_desktop/claude_desktop_config.json - Update the config file with your local paths
- 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 os --file Dockerfile .
# Tag the newly built container
container image tag os instavm/open-skills
# Push the image to the registry
container image push instavm/open-skills
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.