kworkflow / kworkflow/patch-hub

Log color-eyre errors

Open
#47 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new-feature
Dominant language
Rust
Stars
36
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Description:

Since patch-hub has a logging system, it would be nice if some color-eyre errors (AKA Report) were logged

Motivation:

Currently when a fatal error occurs it goes straight into the CLI but aren't registered in the log file. The purpose of a log file is to register every important event during the execution of the program.

Also, some recoverable errors may be relevant for the user, currently those are only discarded

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how patch-hub handles fatal and recoverable color-eyre errors, then locate the existing logging system and log-file path. Done means relevant errors are recorded in the log while fatal errors still reach the CLI and recoverable errors are no longer silently discarded.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.