Skip to content

docs(maintainers): adding block kit types instructions#1861

Merged
srtaalej merged 5 commits intomainfrom
update-agents-block-kit
Apr 28, 2026
Merged

docs(maintainers): adding block kit types instructions#1861
srtaalej merged 5 commits intomainfrom
update-agents-block-kit

Conversation

@srtaalej
Copy link
Copy Markdown
Contributor

Summary

Add "Adding a New Block Kit Type" section to AGENTS.md documenting how to define, register, export, and test new Block Kit models (blocks, elements, and composition objects)

Test plan

  • Verify AGENTS.md renders correctly on GitHub
  • Confirm the documented patterns match actual code in slack_sdk/models/blocks/

@srtaalej srtaalej requested a review from a team as a code owner April 27, 2026 19:30
@srtaalej srtaalej self-assigned this Apr 27, 2026
@srtaalej srtaalej added the enhancement M-T: A feature request for new functionality label Apr 27, 2026
@zimeg zimeg changed the title agents: adding block kit types instructions docs(maintainers): adding block kit types instructions Apr 27, 2026
@zimeg zimeg added docs M-T: Documentation work only and removed enhancement M-T: A feature request for new functionality labels Apr 27, 2026
Copy link
Copy Markdown
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.

@srtaalej Is this a document we can link to from this root file as:

  • AGENTS.md
  • slack_sdk/models/AGENTS.md

I'm worried of overloading the initial context when these details might be saved for later?

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.01%. Comparing base (9435412) to head (e9a85f5).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1861   +/-   ##
=======================================
  Coverage   84.01%   84.01%           
=======================================
  Files         117      117           
  Lines       13256    13256           
=======================================
  Hits        11137    11137           
  Misses       2119     2119           

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

@srtaalej srtaalej requested a review from zimeg April 27, 2026 19:51
Copy link
Copy Markdown
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.

@srtaalej Looks solid and I'm optimistic for upcoming additions that use this 🤖

A few notes below are thoughts but we should refine this document with future findings!

@@ -0,0 +1,73 @@
# AGENTS.md — Block Kit Models
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🤖 suggestion(non-blocking): Including a brief description of this entire package might be useful here. I'm not sure how much context otherwise is known but we can iterate on this as we find useful?

Comment thread slack_sdk/models/AGENTS.md Outdated
@srtaalej srtaalej merged commit df39bee into main Apr 28, 2026
18 checks passed
@srtaalej srtaalej deleted the update-agents-block-kit branch April 28, 2026 19:05
@zimeg zimeg added this to the 3.41.1 milestone Apr 28, 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 semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants