tmux-python / tmux-python/libtmux
Move uncovered libs from `libtmux.common` to `libtmux._internal`
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 127
- Avg merge
- 2h 13m
- Merged PRs (30d)
- 1
Description
If an API is subject to break lets make it obvious its not covered by version policy
Not sure if all internal APIs will be in _internal but we need to be deliberate about making APIs ship in prod releases
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 by reviewing the APIs and libraries currently under libtmux.common, then compare them with the intended role of libtmux._internal. Decide which uncovered APIs should move so it is clear which are excluded from the version policy. Done means the internal boundary is deliberate and production-facing APIs remain clearly identified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100