-
Couldn't load subscription status.
- Fork 365
Update CLAUDE.md and link to existing documentation #1347
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR standardizes development tooling around uv as the environment manager and improves documentation organization. The changes focus on aligning local development workflows with CI/CD, enabling consistent code quality checks, and making documentation more discoverable through better organization and quick links.
Key changes:
- Standardize on
uvfor environment management across Makefile, CI workflows, and documentation - Enable flake8 and black pre-commit hooks while removing obsolete encoding pragma hook
- Reorganize CLAUDE.md with focused essential commands and comprehensive documentation quick links
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Makefile | Add uv installation target, update pylint to use uv run, remove --disable-warnings from pytest |
| CLAUDE.md | Restructure with clearer sections, move performance details to dedicated docs, add documentation quick links |
| .pre-commit-config.yaml | Enable flake8 and black hooks, remove fix-encoding-pragma hook |
| .nvim.lua | Add flake8 and pylint to ALE linters configuration |
| .github/workflows/lint.yml | Install uv in CI, update pylint job to use uv run instead of pip install |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
f9d8e25 to
6da8c66
Compare
|
Also, a note before we commit. AGENTS.md seems to be where the non-proprietary crowd are headed for Code Agent context (see, for example, https://pnote.eu/notes/agents-md/#agentsmd-becomes-the-convention). Shall we consolidate on AGENTS.md and symlink CLAUDE.md and GEMINI.md to that? (The existing AGENTS.md seems more focused toward the llms.md crowd...) |
d022b3e to
e3772c1
Compare
Document awareness Examples of using uv for local chores Signed-off-by: Jonathan Springer <[email protected]>
Fixed broken documentation links to point to actual existing files: - virtual-servers.md -> api-usage.md#virtual-server-management - architecture/README.md -> architecture/index.md - architecture/adr/README.md -> architecture/adr/index.md - architecture/security.md -> architecture/security-features.md - manage/scaling.md -> manage/scale.md - deployment/docker.md -> deployment/container.md - testing/security.md -> testing/fuzzing.md Signed-off-by: Mihai Criveti <[email protected]>
e3772c1 to
30dd983
Compare
Summary
Changes
Documentation Improvements
Code Quality Tooling
Build System Updates
make uvtarget to ensure uv is installed (brew or curl fallback)make pylintto useuv runwith proper error handlingmake testto show warnings (remove --disable-warnings)--fail-on E --fail-under 10CI/CD Alignment
uv runinstead of pip installTest Plan
make venv install-dev- virtual environment setup worksmake flake8- linting passesmake pylint- pylint checks pass with uvmake black- formatting applied correctlymake pre-commit- all pre-commit hooks executemake test- tests pass with warnings visible