Skip to content

added planning MD file useful for agents - #440

Open
rozyczko wants to merge 3 commits into
developfrom
planning-folder
Open

rozyczko wants to merge 3 commits into
developfrom
planning-folder

Conversation

@rozyczko

Copy link
Copy Markdown
Member

Architecture Documentation:

  • Added a new .planning/codebase/ARCHITECTURE.md file that describes the project's layered architecture, key facades (Project, MultiFitter), data flow for classical and Bayesian fits, persistence mechanisms, error handling strategies, and cross-cutting concerns such as logging, validation, threading, and serialization. This document also details the main abstractions and entry points for the codebase.

Codebase Concerns and Technical Debt:

  • Added a new .planning/codebase/CONCERNS.md file that audits the current state of the codebase, highlighting major risks and technical debt. This includes issues with coupling to EasyScience internals (e.g., monkeypatching, private imports), size and complexity hotspots (large modules like project.py), persistence format limitations, testing gaps, repository hygiene issues, and important numerical/physics conventions. The document also tracks ongoing work and uncommitted changes.

@rozyczko rozyczko added [scope] documentation Documentation only changes (major.minor.patch.POST) chore Chore changes to the code [priority] high Should be prioritized soon labels Oct 15, 2026
@codecov

codecov Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.69%. Comparing base (66adaf5) to head (63a2d4b).
⚠️ Report is 7 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #440      +/-   ##
===========================================
+ Coverage    95.41%   95.69%   +0.28%     
===========================================
  Files           59       60       +1     
  Lines         7042     7294     +252     
===========================================
+ Hits          6719     6980     +261     
+ Misses         323      314       -9     
Flag Coverage Δ
integration 38.93% <ø> (-0.22%) ⬇️
unittests 95.69% <ø> (+0.28%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 13 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

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

Labels

chore Chore changes to the code [priority] high Should be prioritized soon [scope] documentation Documentation only changes (major.minor.patch.POST)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant