Skip to content

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

Merged
WilliamBergamin merged 2 commits into
mainfrom
establish-pattern-for-dependencies
Jul 16, 2026
Merged

docs(deps): establish and apply a managing-dependencies convention#1915
WilliamBergamin merged 2 commits into
mainfrom
establish-pattern-for-dependencies

Conversation

@WilliamBergamin

@WilliamBergamin WilliamBergamin commented Jul 15, 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 Python matrix (3.7 → 3.14 + PyPy) and dependency diffs stay readable.

Testing

  • Diff each requirements/*.txt and confirm no version constraint changed (only comments/layout).
  • Confirm optional.txt uses full-line comments only, since it feeds wheel metadata via [tool.setuptools.dynamic] in pyproject.toml.
  • CI install steps should behave identically across the full matrix.

Category

  • /docs (Documents)

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.

🤖 Generated with Claude Code

WilliamBergamin and others added 2 commits July 15, 2026 15:36
Add the managing-dependencies skill documenting the requirements-file
layout convention and the PEP 508 python_version marker pattern that
keeps one set of pins working across the full Python matrix (3.7-3.14
plus PyPy). Correct the file-scope table: documentation.txt is not
installed by any CI job (only the manual docs script), and point the
"which files need markers" decision at .github/workflows/ci-build.yml
as the source of truth.

Route the AGENTS.md Dependencies section to the skill rather than
restating its mechanism.

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

Apply the one-dependency-per-section layout across all requirements/*.txt
files: install header, per-dep name header, and full-line `Note:` rationale
comments. Convert trailing inline comments to full-line notes and remove the
empty trailing `;` fossils in tools.txt. Refine the skill doc so rationale
notes start with `Note:` and its examples match the section layout.

No version pins change; this is a formatting/documentation pass only.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@WilliamBergamin WilliamBergamin added the dependencies Pull requests that update a dependency file label Jul 15, 2026
@WilliamBergamin WilliamBergamin self-assigned this Jul 15, 2026
@WilliamBergamin WilliamBergamin marked this pull request as ready for review July 15, 2026 21:20
@WilliamBergamin WilliamBergamin requested a review from a team as a code owner July 15, 2026 21:20
@codecov

codecov Bot commented Jul 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.14%. Comparing base (c1e2c10) to head (8c6fc75).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1915      +/-   ##
==========================================
- Coverage   84.15%   84.14%   -0.01%     
==========================================
  Files         117      117              
  Lines       13366    13366              
==========================================
- Hits        11248    11247       -1     
- Misses       2118     2119       +1     

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

@zimeg zimeg left a comment

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.

🐍 @WilliamBergamin Thinking ahead! I like these changes 🎁 ✨

Comment thread requirements/testing.txt
Comment on lines +32 to 34
# boto3
# Note: used only under slack_sdk/*_store.
boto3<=2

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.

👁️‍🗨️ praise: Thanks for formatting dependencies with additional comments to follow!

@WilliamBergamin WilliamBergamin merged commit 99f4fed into main Jul 16, 2026
18 checks passed
@WilliamBergamin WilliamBergamin deleted the establish-pattern-for-dependencies branch July 16, 2026 15:54
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