docs: end-user install methods + CONTRIBUTING guide#4
Merged
Conversation
Expand the README Install section with isolated CLI installs straight from the git remote (uv tool install / pipx, GitHub or Codeberg), and keep the editable clone path for development. Add CONTRIBUTING.md covering the dev setup, the ruff/mypy/pytest quality gates, the project layout, the SPDX-header and path-safety conventions, and the branch/PR flow across the two mirrors. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Closes #3.
Summary
uv tool install/pipx, GitHub or Codeberg), keeping the editable clone path for development.ruff/mypy --strict/pytestquality gates, project layout, the SPDX-header + path-safety conventions, and the branch/PR flow across the two mirrors.Test plan
ruff check ./mypy src/pytest -vstill green (unchanged frommain).Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/