MatterMiners/cobald

Flatten and separate public/plugin utilities

Open

#101 opened on Oct 26, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Python (13 forks)auto 404
help wantedsubject: code health

Repository metrics

Stars
 (11 stars)
PR merge metrics
 (PR metrics pending)

Description

The cobald namespace is currently a deeply nested hodgepodge of public/plugin utilities for "users", internal high-level components, and convoluted implementation details. This makes it hard to use, discover, document and maintain. The layout should be refactored to have a consistent structure.

  • A "use this" sub-package for external projects, e.g. cobald.plugins and perhaps cobald.protocols
  • Per major component a "high level API" sub-package
  • Moving all implementations to _private named sub-packages

Contributor guide

Research direction
Explore the current `cobald` package structure to identify which modules are public utilities, internal components, and implementation details. Then propose a new layout with `cobald.plugins`, `cobald.protocols`, and `cobald. private` subpackages, moving appropriate modules accordingly.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65