Spaces:
Sleeping
Sleeping
| # Contributing to PicoClaw | |
| Thank you for your interest in contributing to PicoClaw! We welcome contributions from everyone. | |
| ## Ways to Contribute | |
| 1. **Skills**: Create new skills in the `skills/` directory. See existing skills for examples. | |
| 2. **Core**: Improve the agent loop, tool execution, or provider integrations. | |
| 3. **Docs**: Improve documentation, translations, or examples. | |
| 4. **Bugs**: Report issues or fix existing ones. | |
| ## Development Setup | |
| 1. **Prerequisites**: | |
| * Go 1.21+ | |
| * Docker (optional, for testing) | |
| 2. **Build**: | |
| ```bash | |
| make build | |
| ``` | |
| 3. **Run**: | |
| ```bash | |
| ./build/picoclaw agent -m "Hello" | |
| ``` | |
| ## Skill Development | |
| Skills are the easiest way to extend PicoClaw. A skill consists of: | |
| * `SKILL.md`: Metadata and documentation. | |
| * Scripts: Shell, Python, or other scripts that perform the actual work. | |
| Example structure: | |
| ``` | |
| skills/ | |
| my-skill/ | |
| SKILL.md | |
| scripts/ | |
| do_something.sh | |
| ``` | |
| ## Pull Request Process | |
| 1. Fork the repository. | |
| 2. Create a new branch (`git checkout -b feature/amazing-feature`). | |
| 3. Commit your changes. | |
| 4. Push to the branch. | |
| 5. Open a Pull Request. | |
| ## Code Style | |
| * Follow standard Go conventions (`gofmt`). | |
| * Keep functions small and focused. | |
| * Add comments for complex logic. | |
| ## License | |
| By contributing, you agree that your contributions will be licensed under the MIT License. | |