zhshuvo/HuggingClaw

1# Contributing to HuggingClaw2 3Thanks for your interest in contributing! 🦞4 5## How to Contribute6 7### Bug Reports8- Open an issue with a clear description9- Include your HF Space logs if possible10- Mention which LLM provider you're using11 12### Feature Requests13- Open an issue with the `enhancement` label14- Describe the use case — why is this needed?15 16### Pull Requests171. Fork the repo182. Create a feature branch: `git checkout -b feature/my-feature`193. Make your changes204. Test locally with Docker: `docker build -t huggingclaw . && docker run -p 7861:7861 --env-file .env huggingclaw`215. Commit with a clear message226. Push and open a PR23 24### Code Style25- Shell scripts: use `set -e`, quote variables, comment non-obvious logic26- Keep it simple — this project should stay easy to understand27- No unnecessary dependencies28 29### Testing30- If touching routing or Docker startup, verify both `/app/` (OpenClaw UI) and `/terminal/` (JupyterLab terminal).31- Test with at least one LLM provider (Anthropic, OpenAI, or Google)32- Test with and without Telegram enabled33- Test with and without workspace backup enabled34- Verify dashboard setup and auto-sync work35 36## Development Setup37 38```bash39cp .env.example .env40# Fill in your values41docker build -t huggingclaw .42docker run -p 7861:7861 --env-file .env huggingclaw43```44 45## Questions?46 47Open an issue or start a discussion. We're friendly! 🤝48