docs: add contributing guide#347
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a new CONTRIBUTING.md file that outlines the contribution guidelines, development workflow, and code style requirements for the Heretic project. The review feedback correctly identifies an incorrect URL for the ty type-checking tool and provides a suggestion to point to the correct repository.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
|
||
| - **Formatting**: Code is formatted with [Ruff](https://docs.astral.sh/ruff/). Run `uv run ruff format .` before committing. | ||
| - **Linting**: Imports are sorted and code is linted with Ruff. Run `uv run ruff check --extend-select I .` to check. | ||
| - **Type checking**: All code is type-checked with [ty](https://github.com/astral-sh/ty). Run `uv run ty check .` to verify. |
There was a problem hiding this comment.
The URL for ty is incorrect. ty is maintained by p-e-w, not astral-sh. It should point to https://github.com/p-e-w/ty.
| - **Type checking**: All code is type-checked with [ty](https://github.com/astral-sh/ty). Run `uv run ty check .` to verify. | |
| - **Type checking**: All code is type-checked with [ty](https://github.com/p-e-w/ty). Run `uv run ty check .` to verify. |
Summary
CONTRIBUTING.mdwith development setup instructions, code style guidelines, check commands, and PR conventions..gemini/styleguide.md,pyproject.toml, and CI workflow configuration.Motivation
The repository currently lacks a contributing guide. New contributors have to inspect the CI configuration and style guide to understand the expected tooling, code style, and PR format. A dedicated
CONTRIBUTING.mdlowers the barrier to entry and consolidates this information in one place.What the guide covers
uv sync --all-extras --devruff format --check,ruff check,ty check,uv build)feat:,fix:,perf:,docs:,build:), no unrelated code modificationsVerification
.github/workflows/ci.yml), style guide (.gemini/styleguide.md), and project configuration (pyproject.toml).