Skip to content

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

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

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

Conversation

@Openclaw-ai-dev
Copy link

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

Description

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

Contents

  • 📦 Development environment setup: Go 1.21+, Make, Git installation
  • 🔨 Build and run instructions: Using Makefile, CLI commands
  • Testing guidelines: Running tests, coverage, benchmarks
  • 📝 Code style guide: gofmt, Go conventions, error handling examples
  • 🔄 PR submission process: Conventional commits, checklist, review workflow
  • 🗂️ Project structure: Directory layout and package organization
  • 💬 Community links: Discord, GitHub issues, WeChat

Why this matters

PicoClaw is growing! A clear contributing guide will:

  • Lower the barrier to entry for new contributors
  • Ensure consistent code quality and style
  • Streamline the PR review process
  • Build a healthy open-source community 🦐

Testing

Verified that:

  • All markdown links work
  • Code examples are accurate
  • Instructions match current project setup
  • Follows conventional documentation structure

Closes #5


Note

Low Risk
Documentation-only change adding a new contributing guide; no runtime, build, or security-sensitive code paths are modified.

Overview
Adds a new CONTRIBUTING.md to standardize contributor onboarding and expectations.

The guide documents local setup (Go/Make/Git), build/run and test commands, code style conventions (formatting, comments, error handling), and the pull request process (branching, conventional commits, checklist), plus a brief project structure overview and community/help links.

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

Comprehensive CONTRIBUTING.md covering:
- Development environment setup (Go 1.21+, tools)
- Build and run instructions (make, CLI usage)
- Testing guidelines (go test, coverage, benchmarks)
- Code style guide (gofmt, conventions, error handling)
- PR submission process (commit messages, checklist)
- Project structure overview
- Community links (Discord, GitHub issues)

Designed to help new contributors get started quickly with
clear instructions and best practices.

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