[Docs] Refresh contributing guide and README#4237
Merged
Merged
Conversation
- Recommend `uv` for dev setup (uv venv + uv pip install), drop conda mention - Add prominent "open an issue first" section for bug reports and feature requests - Streamline the PR workflow steps (12 → 11), simplify test examples - README: recommend uv for installation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
hanouticelina
approved these changes
May 19, 2026
hanouticelina
left a comment
Collaborator
There was a problem hiding this comment.
Much better! hopefully that helps reduce the number of sloppy PRs
Co-authored-by: célina <hanouticelina@gmail.com>
Contributor
|
This PR has been shipped as part of the v1.16.0 release. |
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
2 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
uv: dev setup now usesuv venv+uv pip install -e ".[dev]"instead of generic venv/conda. README also mentionsuvinstead of conda. (suggested in this slack thread). Basically, "let's be opinionated on the tooling".pytestdirectly.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes; the main risk is confusing contributors if the new preferred workflow/tooling guidance is inaccurate or too strict.
Overview
Adds a prominent “open an issue first” policy to
CONTRIBUTING.md, clarifying when PRs are welcome and setting expectations for AI/agent-assisted submissions.Refreshes contributor workflow docs by recommending
uvfor dev setup, consolidating themake style/make qualityguidance, simplifyingpytestexamples, and removing the pre-commit hooks section;README.mdnow also highlightsuvas the recommended install path.Reviewed by Cursor Bugbot for commit 9b2b625. Bugbot is set up for automated code reviews on this repo. Configure here.