Skip to content

Commit 8db6735

Browse files
nathanjmcdougallnathanjmcdougall
committed
Give contract strategy for usethis-qa-import-linter 
1 parent 7274253 commit 8db6735

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

  • .agents/skills/usethis-qa-import-linter

‎.agents/skills/usethis-qa-import-linter/SKILL.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Use the Import Linter software on the usethis project
44
compatibility: usethis, Python, import-linter
55
license: MIT
66
metadata:
7-
version: "1.0"
7+
version: "1.1"
88
---
99

1010
# Import Linter
@@ -54,9 +54,14 @@ layers =
5454
exhaustive = true
5555
```
5656

57+
## Contract Strategy
58+
59+
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.
60+
5761
## Procedure
5862

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

0 commit comments

Comments
 (0)