tariqshihadah/rangel

Periodic cleanup and refactor

Open

#1 opened on Nov 30, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (0 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

It's been a while since the codebase has been reviewed in depth. I'll be going through the RangeCollection class to remove unused/deprecated features, add documentation where needed, and do some general cleanup.

There are likely many low-level methods that may be removed; I'll identify all features used directly in the linref package to determine what can be removed/modified without impact and what may need an associated version requirement on the next rangel and linref releases.

Contributor guide

Research direction
Explore the RangeCollection class in the rangel package, list its public methods, and identify unused or deprecated ones by checking usages in the linref package. Then propose removals, documentation additions, and versioning updates.
Tech stack
python
Domain
data
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.
Over 1 week
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.
Needs investigation
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25