canonical / canonical/craft-application

Explicitly separate public and private APIs

Open
#386 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
14
Forks
29
Avg merge
2d 3h
Merged PRs (30d)
12

Description

### What needs to get done

Right now it's hard to know what's public and what's private. For example, the `launchpad` and `remote` modules are probably mostly private, but it's not explicit.

### Why it needs to get done

We want to prevent every change from becoming a breaking change.

Contributor guide

Open the contributing guide

Research direction

The issue names the launchpad and remote modules; start by inspecting how those modules are exposed and reviewing the package's current public surface. Identify the intended public and private boundaries, then confirm that the resulting separation makes it clear which changes can be treated as breaking API changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.