Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (64 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

94 lines (64 loc) · 2.26 KB
Raw

Contributing to GCode

Quick Setup

git clone https://github.com/shauryagangrade/GCode.git
cd GCode
pip install -e .
mkdir -p ~/.gcode && cp .env.example ~/.gcode/.env
gcode

You will need an OpenRouter API key. Copy the .env.example file to ~/.gcode/.env and fill in your OPENROUTER_API_KEY.

How to Contribute

Reporting Bugs

Open an issue using the bug report template. Include steps to reproduce, expected vs actual behavior, and environment info.

Requesting Features

Open an issue using the feature request template.

Submitting a PR

  1. Fork the repo and create a branch: git checkout -b feat/your-feature
  2. Make your changes
  3. Verify: pytest — must pass clean
  4. Open a PR against main

Good First Issues

Look for issues labeled good first issue or help wanted — both are reserved for contributors submitting their first PR to GCode. If you've already had a PR merged, a bot will unassign you and close any PR that claims them, so pick an unreserved issue instead.

Code Style

  • Follow PEP 8 styling guidelines.
  • Write clean, readable code with descriptive variable names.
  • Ensure all tests pass before opening a PR.

Pre-commit Hooks

Install the hooks once so lint, formatting, and type checks run before every commit (they mirror the CI lint job):

uv run pre-commit install

Run them on the whole tree any time with:

uv run pre-commit run --all-files

PR Guidelines

  • One PR per change — keep scope tight
  • PR description must explain why, not just what
  • Ensure any new tools or CLI commands are documented.
  • AI-assisted code is welcome — provided you have reviewed and tested the output.

Commit Style

Conventional Commits:

feat: add dark mode toggle
fix: correct timezone offset in tournament dates
docs: update quick start steps

Types: feat | fix | docs | style | refactor | perf | test | ci | chore

Community

GitHub Issues: https://github.com/shauryagangrade/GCode/issues