Skip to content

Add repository refactor roadmap (rmap.md)#52

Open
ShakyPizza wants to merge 2 commits intomainfrom
codex/extract-key-functions-to-rmap.md
Open

Add repository refactor roadmap (rmap.md)#52
ShakyPizza wants to merge 2 commits intomainfrom
codex/extract-key-functions-to-rmap.md

Conversation

@ShakyPizza
Copy link
Owner

Motivation

  • The codebase contains duplicated domain logic, monolithic orchestrators, and import-time side effects making a repo-wide rebase risky and costly.
  • Provide a single, consumable roadmap that extracts key functions, highlights refactor targets, and proposes a migration-first file layout to reduce rebase conflicts.

Description

  • Add a new root-level rmap.md that maps runtimes (Discord bot, GUI, FastAPI web), key modules (WOM.py, utils/*, weeklyupdater/*, web/*, gui.py), and the important functions to extract.
  • Documented major pain points (duplication, global state, mixed concerns), a domain-first proposed file structure, a phased migration plan, and a short practical checklist to start the refactor.
  • Recommend extraction priorities (rank service, CSV/JSON repositories, command modules, report helpers) and compatibility-first migration strategy to minimize merge/rebase friction.
  • No runtime code behavior was changed; this is a planning/documentation-only addition.

Testing

  • Ran the project's test suite with pytest -q from the repository root to validate repository state.
  • Test run failed during collection because python/utils/baserow_connect.py raises a ValueError when the Baserow token is not set in python/config.ini, preventing tests from loading (ValueError: Baserow token is not set in the config.ini file.).
  • No code changes were made to address the test failure in this PR; the failure is reported so the next refactor steps can add an import-time-safe Baserow client or test stubs before further test runs.

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant