Amend API semver RFC to discuss "OIBITs"
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 1.7k
- Avg merge
- 16h 14m
- Merged PRs (30d)
- 1
Description
The API semver RFC did not take into account the impact of "OIBIT" traits (which have a .. impl). In particular, these traits can introduce downstream sensitivity to every aspect of a data type's representation, even if that representation is private.
Effectively, OIBITs make it possible for downstream crates to make promises on behalf of upstream crates that can easily be broken.
I don't think this should change anything about the policy itself, but it'd be worth amending the RFC to discuss it.
Contributor guide
No contributing guide indexed for this repository
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 reading the API semver RFC linked in the issue, especially its treatment of representation and downstream compatibility. Amend the RFC discussion to cover how OIBIT traits with a .. impl can expose sensitivity to private representation, while leaving the existing policy unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100