Skip to content

Give contract strategy for usethis-qa-import-linter #1370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 1 commit into from
Mar 11, 2026
Merged

Give contract strategy for usethis-qa-import-linter #1370

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .agents/skills/usethis-qa-import-linter/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Use the Import Linter software on the usethis project
compatibility: usethis, Python, import-linter
license: MIT
metadata:
version: "1.0"
version: "1.1"
---

# Import Linter
Expand Down Expand Up @@ -54,9 +54,14 @@ layers =
exhaustive = true
```

## Contract Strategy

Not every module needs an associated contract for its submodules. Having contracts for every level of the module structure can lead to unnecessary maintenance overhead. Generally, it is rare to create new contracts.

## Procedure

1. Ensure the module structure complies with the Import Linter configuration.
2. Explicitly add/rename new/modified modules to their parent-level contract (to adhere to the `exhaustive` setting).
3. For major refactorings, rationalize the module structure and update the Import Linter configuration accordingly.
4. Run Import Linter to verify that all contracts are satisfied.
4. Avoid creating new contracts unless explicitly instructed.
5. Run Import Linter to verify that all contracts are satisfied.