Skip to content

docs(deps): establish and apply a managing-dependencies convention#1551

Open
WilliamBergamin wants to merge 1 commit into
mainfrom
improve-dependency-structure
Open

docs(deps): establish and apply a managing-dependencies convention#1551
WilliamBergamin wants to merge 1 commit into
mainfrom
improve-dependency-structure

Conversation

@WilliamBergamin

@WilliamBergamin WilliamBergamin commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Establishes a single, self-documenting convention for requirements/*.txt and applies it repo-wide, so one set of pins keeps working across the whole CPython matrix (3.7 → 3.14) and dependency diffs stay readable. Inspired by the sibling change in slackapi/python-slack-sdk#1915, adapted to bolt-python.

What's here:

  • New managing-dependencies skill.
  • Reformats all six requirements/*.txt files to the convention.
  • Points AGENTS.md at the skill from the Dependencies section.

No version constraint changed

Testing

  • run the tests locally
  • run the CI

Category

  • slack_bolt.App and/or its core components
  • slack_bolt.async_app.AsyncApp and/or its core components
  • Adapters in slack_bolt.adapter
  • Document pages under /docs
  • Others — dependency tooling / repo convention (requirements/, .claude/skills/, AGENTS.md)

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 ./scripts/install_all_and_run_tests.sh after making the changes.

Add a `managing-dependencies` skill that documents one layout and
`python_version` marker convention for `requirements/*.txt`, and apply it
across every requirements file so one set of pins keeps working over the
full CPython 3.7-3.14 matrix and dependency diffs stay readable.

- New `.claude/skills/managing-dependencies/SKILL.md` describing the
  `# name` + `# Note:` layout, the marker-split pattern, canonical marker
  style, and how to derive floor/ceiling versions from PyPI. Adapted to
  bolt-python: CPython-only (no PyPy section) and no wheel-metadata file.
- Reformat all six `requirements/*.txt` files to the convention. No
  version constraint changes; markers normalized to the spaced canonical
  style and the fossil trailing `;` on pytest-asyncio removed.
- Point `AGENTS.md` at the skill from the Dependencies section.

Verified pin-equivalence: every file resolves to an identical set of
specifiers per package across Python 3.7-3.14 before and after.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@codecov

codecov Bot commented Jul 16, 2026

Copy link
Copy Markdown

Codecov Report

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1551   +/-   ##
=======================================
  Coverage   91.54%   91.54%           
=======================================
  Files         228      228           
  Lines        7285     7285           
=======================================
  Hits         6669     6669           
  Misses        616      616           

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

@WilliamBergamin WilliamBergamin self-assigned this Jul 16, 2026
@WilliamBergamin WilliamBergamin added the dependencies Pull requests that update a dependency file label Jul 16, 2026
@WilliamBergamin WilliamBergamin marked this pull request as ready for review July 16, 2026 17:09
@WilliamBergamin WilliamBergamin requested a review from a team as a code owner July 16, 2026 17:09
@WilliamBergamin WilliamBergamin requested a review from srtaalej July 16, 2026 18:27

@srtaalej srtaalej left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great ⭐

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants