docs: create comprehensive CONTRIBUTING.md guide (#5)#12
Open
addidea wants to merge 1 commit intoClawland-AI:mainfrom
Open
docs: create comprehensive CONTRIBUTING.md guide (#5)#12addidea wants to merge 1 commit intoClawland-AI:mainfrom
addidea wants to merge 1 commit intoClawland-AI:mainfrom
Conversation
Closes Clawland-AI#5 Complete development guide for PicoClaw contributors: **Sections** (7 main sections): 1. Development Environment Setup 2. Building and Running Locally 3. Running Tests 4. Code Style Guide 5. Pull Request Process 6. Project Structure 7. Common Tasks **Development Environment**: - Prerequisites (Go 1.24+, Git, Make) - Installation steps - Dependency management - Verification commands **Build Instructions**: - Quick start (`make build`) - Run from source - Multi-platform builds (AMD64, ARM64, RISC-V) - System-wide installation **Testing Guide**: - Run all tests - Package-specific tests - Coverage reports - Race detection - Benchmarks **Code Style**: - Go conventions (gofmt, Effective Go) - Linting (`make lint`) - Project structure - Naming conventions (packages, files, types) - Error handling best practices - Testing patterns (table-driven tests, >80% coverage) **PR Process** (6 steps): 1. Fork and clone 2. Create feature branch (feat/fix/docs/test) 3. Make changes 4. Test locally 5. Commit (Conventional Commits) 6. Push and open PR with checklist **Project Structure**: - cmd/ - Main entry point - pkg/ - Public packages (agent, bus, channels, providers, tools) - skills/ - Agent skills - Complete directory tree **Common Tasks**: - Add new channel - Add new tool - Add new skill - Update dependencies - Debug configuration **Community**: - Bug reporting guidelines - Discord, GitHub Discussions - License info Production-ready contributor guide! 📚
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Complete development and contribution guide for PicoClaw with detailed setup instructions, code style guidelines, and PR process.
Closes #5
What's Included
✅ Development Environment Setup
make deps✅ Building and Running
make build✅ Testing Guide
make testgo test -coverprofile)go test -race)✅ Code Style Guide
make lint,make lint-fix✅ Pull Request Process (6-step guide)
✅ Project Structure
Complete directory tree with explanations:
cmd/- Main entry pointpkg/- Public packages (agent, bus, channels, providers, tools)skills/- Agent skillsassets/- Images, assets✅ Common Tasks
How-to guides for:
✅ Community & Support
Requirements Met
Example: PR Checklist
Example: Code Style
Benefits
Production-ready contribution guide! 📚