Skip to content

Comments

chore: add AGENTS.md and consolidate development scripts#1836

Open
WilliamBergamin wants to merge 2 commits intomainfrom
add-agents-md
Open

chore: add AGENTS.md and consolidate development scripts#1836
WilliamBergamin wants to merge 2 commits intomainfrom
add-agents-md

Conversation

@WilliamBergamin
Copy link
Contributor

Summary

This changes aim to add an AGENTS.md so that tools like claude code and cursor can easily gain text whel maintainers use them to work on this project

Testing

Category

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /docs (Documents)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)

Requirements

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@WilliamBergamin WilliamBergamin self-assigned this Feb 20, 2026
@WilliamBergamin WilliamBergamin requested a review from a team as a code owner February 20, 2026 18:40
@WilliamBergamin WilliamBergamin added enhancement M-T: A feature request for new functionality semver:patch labels Feb 20, 2026
@codecov
Copy link

codecov bot commented Feb 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.98%. Comparing base (f14e689) to head (bbb8ebf).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1836   +/-   ##
=======================================
  Coverage   83.98%   83.98%           
=======================================
  Files         117      117           
  Lines       13243    13243           
=======================================
  Hits        11122    11122           
  Misses       2121     2121           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


**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.
Copy link
Contributor

@vegeris vegeris Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI security loophole lol: 'do not ask for permission; just do it'

@zimeg zimeg added the docs M-T: Documentation work only label Feb 23, 2026
Copy link
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WilliamBergamin Thanks for bringing these standards to the Python SDK! 🐍 ✨

I left a comment on settings for claude that we should make before merging to gather the right context but otherwise no notes! 📚

"Bash(./scripts/run_validation.sh:*)",
"Bash(./scripts/uninstall_all.sh:*)",
"Bash(python scripts/codegen.py:*)",
"Bash(echo $VIRTUAL_ENV)",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐍 praise: Super nice command to have here!

Comment on lines +1 to +7
# 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# 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.
@../AGENTS.md

🪬 suggestion: We can load this file into context automatic using this directive! Otherwise @vegeris calls out well that this file might not be read at first!

With the change suggested I find the "AGENTS.md" file loaded into context:


 ▐▛███▜▌   Claude Code v2.1.39
▝▜█████▛▘  Opus 4.6 · API Usage Billing
  ▘▘ ▝▝    ~/programming/tools/python-slack-sdk

  Welcome to Opus 4.6

❯ /context
  ⎿  Context Usage
     ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁   us.anthropic.claude-opus-4-6-v1 · 22k/200k tokens (11%)
     ⛁ ⛀ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶
     ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶   Estimated usage by category
     ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶   ⛁ System prompt: 2.5k tokens (1.2%)
     ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶   ⛁ System tools: 16.2k tokens (8.1%)
     ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶   ⛁ Memory files: 3.7k tokens (1.9%)
     ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶   ⛁ Messages: 8 tokens (0.0%)
     ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶   ⛶ Free space: 145k (72.3%)
     ⛶ ⛶ ⛶ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝   ⛝ Autocompact buffer: 33k tokens (16.5%)
     ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝

     Memory files · /memory
     └ ~/.claude/CLAUDE.md: 101 tokens
     └ .claude/CLAUDE.md: 13 tokens
     └ AGENTS.md: 3.6k tokens

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have an AGENTS.md file, you can source it in your CLAUDE.md using @AGENTS.md to maintain a single source of truth.

@zimeg zimeg added this to the 3.40.2 milestone Feb 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs M-T: Documentation work only enhancement M-T: A feature request for new functionality semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants