|
Download CONTRIBUTING.md from elyanlabs/trashclaw: direct link, hf CLI and curl.
- Browser
- Download file 2.53 kB
-
https://huggingface.co/elyanlabs/trashclaw/resolve/main/CONTRIBUTING.md
- Command line
-
hf download hf://elyanlabs/trashclaw/CONTRIBUTING.md
-
curl -L -o CONTRIBUTING.md https://huggingface.co/elyanlabs/trashclaw/resolve/main/CONTRIBUTING.md
2.53 kB
Contributing to TrashClaw
Thank you for your interest in contributing to TrashClaw! This guide will help you get started.
Quick Start
- Fork the repository
- Clone your fork locally
- Create a branch for your changes (
git checkout -b feature/my-contribution) - Make your changes and test them
- Commit with a clear message
- Push to your fork and open a Pull Request
Development Setup
Prerequisites
- Python 3.7+ (stdlib only, no pip dependencies required)
- A local LLM server (Ollama, LM Studio, or any OpenAI-compatible endpoint)
- Git
Running Locally
# Clone the repository
git clone https://github.com/YOUR_USERNAME/trashclaw.git
# Replace YOUR_USERNAME with your actual GitHub username
cd trashclaw
# Start your local LLM server (example with Ollama)
ollama serve
# Run TrashClaw
python3 trashclaw.py
# Or with a custom endpoint
TRASHCLAW_URL=http://localhost:11434 python3 trashclaw.py
Project Structure
trashclaw/
βββ trashclaw.py # Main agent (single file, zero dependencies)
βββ tests/ # pytest test suite
βββ plugins/ # Plugin extensions
βββ docs/ # Documentation (model compatibility, etc.)
βββ CONTRIBUTING.md # This file
βββ CONTRIBUTORS.md # Hall of fame
βββ LICENSE # MIT License
βββ README.md # Project overview
Types of Contributions
Code
- New tools or commands
- Bug fixes
- Plugin improvements
- Cross-platform compatibility fixes
Documentation
- README improvements
- Code comments
- Usage examples
- Tutorials
Testing
- Test cases for tools
- Edge case handling
- Platform-specific testing
Code Style
- Python 3.7+ stdlib only β No external dependencies
- Clear function names β Describe what the function does
- Docstrings β Document parameters and return values
- Error handling β Graceful failures with helpful messages
Pull Request Guidelines
- One feature per PR β Keep changes focused
- Test your changes β Run the agent with your modifications
- Update documentation β If you add features, document them
- Follow the existing style β Match the codebase conventions
Questions?
- Open an issue for bugs or feature requests
- Check existing issues before creating new ones
License
By contributing, you agree that your contributions will be licensed under the MIT License.