Skip to content

Add CONTRIBUTING.md #120

Description

@crtahlin

Sub-issue of #114 (developer experience review).

Task

Create CONTRIBUTING.md covering:

  • Prerequisites (Python 3.9+, git)
  • Quick Setup (make setup, .env.example)
  • Development Workflow (branch naming: fix/, feature/, docs/; branch from development)
  • Code Style (ruff, make lint/make format, line length 120, type hints)
  • Testing (make test, pytest markers: integration, local_bee, gateway, x402, blockchain)
  • Commit Conventions (conventional style, focused on what/why)
  • PR Process (checklist, link issues)
  • Version Bumping (PATCH/MINOR/MAJOR, sync __init__.py + pyproject.toml)
  • Architecture pointer to CLAUDE.md and README

Why

Contribution guidance is currently embedded in CLAUDE.md (agent-focused). A standalone CONTRIBUTING.md is the standard location for both human and agent contributors.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions