Conversation
|
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
Apr 15, 2026
Contributor
hanouticelina
left a comment
hanouticelina
left a comment
There was a problem hiding this comment.
Very nice! I also have locally this section:
## Code conventions
### Simplicity is the #1 priority
- No premature abstractions. No unnecessary generalization.
- Don't implement features until they're actually needed.
- Don't accept parameters without a use case.
- No redundant `try`/`except` - don't catch errors already handled up the call stack.
- Prefer strictness now, relax later.
### Follow Python 3.10+ idioms
- `match`/`case` over `if`/`elif` chains when dispatching on a value.
- `str | None` not `Optional[str]`.
- f-strings over `.format()` or `%`.
- Walrus operator (`:=`) when it improves readability.
- Comprehensions over `map`/`filter` with lambdas.
Co-authored-by: célina <[email protected]>
Contributor
Author
|
Good idea about the code conventions! I've added it at the bottom of AGENTS.md + included yours 2 suggestions. Let's get this merged |
Contributor
|
This PR has been shipped as part of the v1.11.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.
This PR updates
AGENTS.mdwith instructions that I usually give to my local Claude. I think they can be relevant to everyone else.In particular:
out.xxxin detail and nudge the agent to add some niceout.hintsto new commandsI also removed parts that felt useless for an AGENTS.md or not relevant for what we work on at the moment.
Any suggestion welcome!
Note
Low Risk
Low risk: documentation-only changes that do not affect runtime behavior. Risk is limited to potentially incorrect guidance for future contributors.
Overview
Updates
AGENTS.mdto emphasize CLI-focused development conventions, including how to structure Typer command groups, reuse standard option types, and use theoutoutput helpers (including confirmations and hints).Adds contribution guidance around destructive operations, user-facing error handling via
CLIError, generated CLI docs regeneration, minimal CLI test expectations, and new conventions for commit/PR titles and descriptions, plus general Python 3.10+ style recommendations.Reviewed by Cursor Bugbot for commit c863a4d. Bugbot is set up for automated code reviews on this repo. Configure here.