canonical / canonical/charmlibs
Document best practices for interfaces and interface libraries
- Dominant language
- Python
- Stars
- 5
- Forks
- 28
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 24
Description
There are common problems faced by many interfaces, like how to add features to an interface in a backwards compatible way, often by extending the meaning of an existing key, or adding a new optional key. We should document best practices for interface maintainers and interface library authors for dealing with common challenges like this.
Some questions around this are captured in https://github.com/canonical/charm-relation-interfaces/issues/14
Contributor guide
Research direction
Start by reading the linked charm-relation-interfaces issue #14 and then locate the repository’s existing documentation entry points for interface libraries. Done means documenting guidance for backward-compatible interface changes, including extending existing keys and adding optional keys, along with the other common challenges identified in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100