chore(claude): add claude code support for maintainers#1445
Open
chore(claude): add claude code support for maintainers#1445
Conversation
zimeg
added
docs
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1445 +/- ##
=======================================
Coverage 90.67% 90.67%
=======================================
Files 226 226
Lines 7205 7205
=======================================
Hits 6533 6533
Misses 672 672 ☔ View full report in Codecov by Sentry. |
WilliamBergamin
requested changes
Feb 19, 2026
Contributor
WilliamBergamin
left a comment
WilliamBergamin
left a comment
There was a problem hiding this comment.
Awesome working putting this together 💯 Looking forward on iterating on this 🚀
What do you think about centralizing this information by putting the contents of .claude/CLAUDE.md into an AGENTS.md and having the .claude/CLAUDE.md be something like
# CLAUDE.md
Persistent context, coding standards, and instructions for AI coding agents have been centralized to `AGENTS.md`.
**CRITICAL INSTRUCTION:** Before answering any questions, writing any code, or executing any commands in this repository, you MUST read the `AGENTS.md` file located in the root directory.
Proceed by silently reading `./AGENTS.md`, do not ask for permission to read it; just do it.| @@ -0,0 +1,3 @@ | |||
| CLAUDE.local.md | |||
| settings.local.json | |||
| worktrees/ | |||
Contributor
There was a problem hiding this comment.
Suggested change
| worktrees/ | |
| worktrees/ | |
| plans/ |
|
|
||
| ## Environment Setup | ||
|
|
||
| A virtual environment (`.venv`) should be activated before running any commands. If tools like `black`, `flake8`, or `pytest` are not found, ask the user to activate the venv. |
Contributor
There was a problem hiding this comment.
In my workflow I use various env_3.x. pattern in order quickly and easily test against different python versions locally 🤔
Suggested change
| A virtual environment (`.venv`) should be activated before running any commands. If tools like `black`, `flake8`, or `pytest` are not found, ask the user to activate the venv. | |
| A python virtual environment (`venv`) should be activated before running any commands. You can verify that the virtual environment is active by checking if the `$VIRTUAL_ENV` environment variable is set with `echo $VIRTUAL_ENV`. | |
| If tools like `black`, `flake8`, 'mypy' or `pytest` are not found, ask the user to activate the venv. |
Comment on lines
+42
to
+48
| ```bash | ||
| pip install -U -e . | ||
| pip install -U -r requirements/testing.txt | ||
| pip install -U -r requirements/adapter.txt | ||
| pip install -U -r requirements/adapter_testing.txt | ||
| pip install -U -r requirements/tools.txt | ||
| ``` |
Contributor
There was a problem hiding this comment.
What do you think about creating a scripts/install.sh that contains the following
#!/bin/bash
# Installs all dependencies of the project
# ./scripts/install.sh
# Update pip to prevent warnings
pip install -U pip
# The package causes a conflict with moto
pip uninstall python-lambda
pip install -U -e .
pip install -U -r requirements/testing.txt
pip install -U -r requirements/adapter.txt
pip install -U -r requirements/adapter_testing.txt
pip install -U -r requirements/tools.txt
# To avoid errors due to the old versions of click forced by Chalice
pip install -U pip clickUpdate the scripts/install_all_and_run_tests.sh to use it, that way we have one source of truth to install all dependencies
Suggested change
| ```bash | |
| pip install -U -e . | |
| pip install -U -r requirements/testing.txt | |
| pip install -U -r requirements/adapter.txt | |
| pip install -U -r requirements/adapter_testing.txt | |
| pip install -U -r requirements/tools.txt | |
| ``` | |
| ```bash | |
| ./scripts/install.sh |
| - **`App` / `AsyncApp`** (`slack_bolt/app/`) -- Central class. Registers listeners via decorators (`@app.event()`, `@app.action()`, `@app.command()`, `@app.message()`, `@app.view()`, `@app.shortcut()`, `@app.options()`, `@app.function()`). Dispatches incoming requests through middleware to matching listeners. | ||
| - **`Middleware`** (`slack_bolt/middleware/`) -- Abstract base with `process(req, resp, next)`. Built-in: authorization, request verification, SSL check, URL verification, assistant, self-event ignoring. | ||
| - **`Listener`** (`slack_bolt/listener/`) -- Has matchers, middleware, and an ack/handler function. `CustomListener` is the main implementation. | ||
| - **`ListenerMatcher`** (`slack_bolt/listener_matcher/`) -- Determines if a listener handles a given request. Built-in matchers for events, actions, commands, messages (regex), shortcuts, views, options. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **`ListenerMatcher`** (`slack_bolt/listener_matcher/`) -- Determines if a listener handles a given request. Built-in matchers for events, actions, commands, messages (regex), shortcuts, views, options. | |
| - **`ListenerMatcher`** (`slack_bolt/listener_matcher/`) -- Determines if a listener handles a given request. Built-in matchers for events, actions, commands, messages (regex), shortcuts, views, options, functions. |
| - **`Middleware`** (`slack_bolt/middleware/`) -- Abstract base with `process(req, resp, next)`. Built-in: authorization, request verification, SSL check, URL verification, assistant, self-event ignoring. | ||
| - **`Listener`** (`slack_bolt/listener/`) -- Has matchers, middleware, and an ack/handler function. `CustomListener` is the main implementation. | ||
| - **`ListenerMatcher`** (`slack_bolt/listener_matcher/`) -- Determines if a listener handles a given request. Built-in matchers for events, actions, commands, messages (regex), shortcuts, views, options. | ||
| - **`BoltContext`** (`slack_bolt/context/`) -- Dict-like object passed to listeners with `client`, `say()`, `ack()`, `respond()`, `complete()`, `fail()`, plus event metadata (`user_id`, `channel_id`, `team_id`). |
Contributor
There was a problem hiding this comment.
Suggested change
| - **`BoltContext`** (`slack_bolt/context/`) -- Dict-like object passed to listeners with `client`, `say()`, `ack()`, `respond()`, `complete()`, `fail()`, plus event metadata (`user_id`, `channel_id`, `team_id`). | |
| - **`BoltContext`** (`slack_bolt/context/`) -- Dict-like object passed to listeners with `client`, `say()`, `ack()`, `respond()`, `complete()`, `fail()`, plus event metadata (`user_id`, `channel_id`, `team_id`, etc...). |
|
|
||
| Always use the project scripts instead of calling `pytest` directly: | ||
| ```bash | ||
| # Run all tests (installs deps, formats, lints, tests, typechecks) |
Contributor
There was a problem hiding this comment.
Suggested change
| # Run all tests (installs deps, formats, lints, tests, typechecks) | |
| # Install all dependencies and run all tests (installs deps, formats, lints, tests, typechecks) |
| "Bash(./scripts/install_all_and_run_tests.sh:*)", | ||
| "Bash(./scripts/lint.sh:*)", | ||
| "Bash(./scripts/run_mypy.sh:*)", | ||
| "Bash(./scripts/run_tests.sh:*)", |
Contributor
There was a problem hiding this comment.
Suggested change
| "Bash(./scripts/run_tests.sh:*)", | |
| "Bash(./scripts/run_tests.sh:*)", | |
| "Bash(./scripts/install.sh:*)", | |
| "Bash(echo $VIRTUAL_ENV)", |
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
3 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
This PR adds support for
claudewith the current project settings generated with the following command and a few adjustments:Permissions were gathered from similar changes to the CLI repo:
🔗 https://github.com/slackapi/slack-cli/blob/main/.claude/settings.json
Testing
We might make updates to these files as we find edges?
Category
Requirements
Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
./scripts/install_all_and_run_tests.shafter making the changes.