bee-san/Ares

[TECHNICAL DEBT] Split Ares into two parts, `project_ares` and `ares_lib`

Open

#166 opened on Dec 26, 2022

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Rust (45 forks)github user discovery
Technical Debtgood first issue

Repository metrics

Stars
 (871 stars)
PR merge metrics
 (Avg merge 1m) (6 merged PRs in 30d)

Description

Why?

Ares is made up of 2 parts:

  1. The CLI
  2. The Library

If someone wants to use the library they would need to import the CLI stuff too. It is a good idea to make the CLI a different app and make it call the library, rather than have them both bundled into one.

Contributor guide

Research direction
Examine the current project structure to separate the CLI and library components. Use Cargo workspaces to create two crates: one for the library (ares lib) and one for the CLI (project ares). Ensure the CLI crate depends on the library crate and all public APIs are properly exported.
Tech stack
rust
Domain
backendcli
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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.
Mostly clear
Prerequisites
RustCargo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65