chore: add claude md and serena#297
Open
mrtam wants to merge 1 commit into
Open
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository guidance/config files intended for external tooling (Claude Code and Serena) to standardize local setup and provide architectural context.
Changes:
- Add a generated
CLAUDE.mdwith development setup, commands, architecture, and conventions. - Add a generated
.serena/project.ymlSerena project configuration. - Add
.serena/.gitignoreto keep Serena cache/local config out of version control.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
CLAUDE.md |
Adds Claude Code-focused repo guidance (setup, commands, architecture notes). |
.serena/project.yml |
Adds Serena project configuration for language/server behavior and project settings. |
.serena/.gitignore |
Ignores Serena cache and local overrides. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
| python -m venv .venv && source .venv/bin/activate | ||
| pip install -e . | ||
| pip install -r requirements.txt # dev deps (locked); requirements.in is the source list |
Comment on lines
+32
to
+35
| - `cloudsmith_cli/cli/` — Click commands, decorators, output formatting, validators, config-file parsing, SAML browser-callback webserver. **No direct API calls live here** — commands call into `core/api/*`. | ||
| - `cli/commands/main.py` defines the top-level `main` Click group (`cls=AliasGroup`). Every other command module imports `main` and registers itself with `@main.command(...)` or `@main.group(...)`. `cli/commands/__init__.py` imports every module so registration happens on import. | ||
| - `cli/command.py` provides `AliasGroup` (DYM + alias support) and JSON-aware Click exception formatting — Click errors are serialized to JSON when `-F json|pretty_json` is in effect (checked from both Click context and `sys.argv`). | ||
| - `cli/decorators.py` is the seam between CLI and API: `@common_cli_config_options`, `@common_cli_output_options`, `@common_api_auth_options`, and `@initialise_api` (which calls `core.api.init.initialise_api` to configure the `cloudsmith_api` SDK with key/host/proxy/SSL/retry/SAML token). `@initialise_mcp` wires up the MCP server. |
Comment on lines
+67
to
+69
| - `pyupgrade --py310-plus` runs on every commit, so use modern syntax (`X | Y` unions, `dict[str, ...]` generics, etc.). | ||
| - Adding a new subcommand: create a module under `cli/commands/`, register it in `cli/commands/__init__.py`, and attach it to `main` (or a subgroup) with the `AliasGroup` for alias support. | ||
| - Adding a new API call: put SDK wrapping in `core/api/<resource>.py`, translate exceptions to `ApiException`, and call it from the command layer — don't import `cloudsmith_api` directly from `cli/commands/*`. |
Comment on lines
+71
to
+72
| # To make sure you have the latest list of tools, and to view their descriptions, | ||
| # execute `uv run scripts/print_tool_overview.py`. |
cloudsmith-iduffy
approved these changes
May 20, 2026
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
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.
Description
CLAUDE.md.serena/project.ymlType of Change
Additional Notes