enforce layers split
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 7
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 5
Description
We are moving a few addons to be core-addons, plone.api should not be used in a few places, but fine in others...
That's all great but in practicality impossible to double check manually on a PR basis unless you have a tool... 🥁 enters import-linter:
https://import-linter.readthedocs.io/en/stable/index.html
Although the main use case is to check dependencies between packages of a single python distribution, it says on the docs that it can handle external packages as well ✨🍀
That sounds like the perfect fit to our organization layer cleanup, right?
@jensens @mauritsvanrees
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the import-linter documentation linked in the issue, then identify the addon and core-addon package boundaries and the places where plone.api usage should be restricted. The issue names no files or tests; done means the intended layer rules are enforced automatically rather than checked manually on each pull request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100