Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
118 lines (86 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

118 lines (86 loc) · 2.96 KB

Contributing to GenCode

Thanks for your interest in contributing! This guide will help you get started.

Quick Start

git clone https://github.com/yanmxa/gencode.git
cd gencode
go build -o gen ./cmd/gen
./gen

Development

Prerequisites

  • Go 1.21+
  • An LLM API key (Anthropic, OpenAI, or Google)

Project Structure

cmd/               # Binary entrypoints
docs/              # Architecture and feature docs
internal/
├── app/           # Interactive app shell and feature-oriented UI orchestration
├── core/          # Reusable agent loop/runtime
├── provider/      # LLM provider implementations and registry
├── tool/          # Built-in tools and execution registry
├── plugin/        # Plugin loading and integration
├── skill/         # Skill loading and registry
├── mcp/           # MCP protocol support
├── config/        # Settings and permissions
├── ui/            # Shared presentational UI components/styles
└── ...            # Other focused subsystems
tests/
└── integration/   # Cross-package behavioral tests

See docs/architecture.md for package responsibilities, dependency direction, and placement rules for new code.

Run Tests

GOCACHE=/tmp/gocache go test ./...

Transcript/session focused suites:

GOCACHE=/tmp/gocache go test ./internal/transcriptstore ./internal/app/session ./tests/integration/session/... ./tests/integration/cli/...

Manual transcript persistence checks, including interactive tmux flows for --continue, --resume, --fork, compact restore, and tool-result hydration, are documented in docs/transcriptstore.md.

Debug Mode

GEN_DEBUG=1 ./gen
# Logs written to ~/.gen/debug.log

How to Contribute

Report Bugs

Open an issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • OS, Go version, and provider used

Suggest Features

Open an issue describing:

  • The problem you're solving
  • Your proposed solution
  • Alternative approaches considered

Submit Code

  1. Fork the repo
  2. Create a branch: git checkout -b feature/your-feature
  3. Make changes and test
  4. Commit with sign-off: git commit -s -m "feat: add feature"
  5. Push and open a PR

Commit Messages

Follow Conventional Commits:

feat: add new feature
fix: resolve bug
docs: update documentation
refactor: restructure code
test: add tests
chore: maintenance tasks

Areas for Contribution

Area Description
Providers Add new LLM providers (Ollama, Mistral, etc.)
Tools Create new built-in tools
MCP Improve MCP server support
TUI Enhance terminal UI/UX
Docs Improve documentation
Tests Increase test coverage

Code of Conduct

Be respectful and constructive. We welcome contributors of all backgrounds and experience levels.

Questions?

Open an issue or start a discussion. We're happy to help!