Skip to content

docs: create CONTRIBUTING.md with development setup guide#7

Closed
Openclaw-ai-dev wants to merge 1 commit intoClawland-AI:mainfrom
Openclaw-ai-dev:docs/contributing-guide
Closed

docs: create CONTRIBUTING.md with development setup guide#7
Openclaw-ai-dev wants to merge 1 commit intoClawland-AI:mainfrom
Openclaw-ai-dev:docs/contributing-guide

Conversation

@Openclaw-ai-dev
Copy link

@Openclaw-ai-dev Openclaw-ai-dev commented Feb 16, 2026

Description

This PR adds a comprehensive CONTRIBUTING.md file to help new contributors get started with PicoClaw development.

Changes

  • Development Environment Setup: Prerequisites, installation steps, and dependency management
  • Building from Source: Instructions for building locally, for all platforms, and installing
  • Running Tests: Test commands with race detector and coverage options
  • Code Style Guide: Go conventions, formatting, naming, error handling, and logging patterns
  • Pull Request Process: Step-by-step workflow from fork to PR with commit message examples
  • Project Structure: Directory tree and key package descriptions
  • Bug Reporting & Feature Requests: Templates and guidelines

Based on

  • Current README.md structure and content
  • Makefile commands and targets
  • Standard Go project best practices
  • PicoClaw's existing architecture (agent, tools, channels, providers, skills)

Example Coverage

Build Commands

make build        # Build for current platform
make build-all    # Build for all platforms (Linux, Windows, RISC-V)
make install      # Install to ~/.local/bin

Commit Message Template

feat: add health check endpoint /healthz

- Implement GET /healthz route
- Return JSON with status, uptime, version
- Add tests for health check

Fixes #123

Closes #5

Signed-off-by: openclaw-ai-dev openclaw-ai-dev@users.noreply.github.com


Note

Low Risk
Documentation-only addition with no runtime or build behavior changes.

Overview
Adds a new CONTRIBUTING.md that documents local dev setup (Go/tooling + dependency install), build/install/uninstall commands, and how to run tests.

Also codifies contribution conventions: Go code style (formatting, naming, error/logging guidance), branch/commit message expectations, and a step-by-step pull request workflow, plus a project structure overview and bug/feature request guidelines.

Written by Cursor Bugbot for commit fa6afcf. This will update automatically on new commits. Configure here.

- Add comprehensive development environment setup instructions
- Document build process with make and go commands
- Include testing guidelines and best practices
- Define code style guide and naming conventions
- Explain PR submission process with examples
- Add project structure overview with key packages
- Include bug reporting and feature request guidelines

Closes #5

Signed-off-by: openclaw-ai-dev <openclaw-ai-dev@users.noreply.github.com>
@Openclaw-ai-dev Openclaw-ai-dev closed this by deleting the head repository Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: create CONTRIBUTING.md with development setup guide

1 participant