Merged
Conversation
Closes codeflash-ai#522 Covers the two audiences the issue calls out: 1. People contributing changes back to Codeflash - development environment setup with uv, the single-command verification via uv run prek, test runner invocation, code-style pointers to .claude/rules/code-style.md, and the branch / commit / PR conventions from .claude/rules/git.md and CLAUDE.md. 2. People using Codeflash in editable mode from a source checkout to optimize their own projects, including the install commands for uv and pip, when editable mode is appropriate vs installing the PyPI package, and a pointer to the README Quick Start for the codeflash init flow.
|
|
Collaborator
|
thanks! |
Collaborator
|
btw I'm working atm on improving a few things like the agents.md, rules etc, will be ready in a few hours |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
CONTRIBUTING.mdfor the two audiences #522 calls out: people contributing changes back to Codeflash, and people who want to run Codeflash from this repo in editable mode to optimize their own projects.Closes #522
Why
The repo has a clear dev workflow (
uv sync,uv run prek,uv run pytest tests/) and a strong code style defined in.claude/rules/code-style.mdandCLAUDE.md, but none of it was surfaced at the root. Contributors have to discover these conventions by readingCLAUDE.mdor by watching CI fail.Content
uv(notpip).uv run prekas the single verification command, plusuv run prek run --from-ref origin/<base>to match CI.uv run pytest tests/) with a subset example..claude/rules/code-style.md: 120-char lines, Python 3.9+, no docstrings on new code, no leading underscores,encoding="utf-8"on file I/O, absolute paths internally..claude/rules/git.md: feature branch offmain, conventional prefixes, concise commit bodies, atomic commits,CF-#<number>link for Linear issues.uv add --editable /path/to/checkoutandpip install -e /path/to/checkout, plus running the CLI directly from the checkout withuv run codeflash .... Includes when to use editable mode vs installing the PyPI package.SECURITY.mdfor security issues.All commands in the guide come from existing repo files (
pyproject.toml,.github/workflows/ci.yaml,.claude/rules/*) - none are fabricated.Testing
Docs-only. No code changes, no test impact.