Document long-term architecture guidance

[mpelteshki]

What changed

• add durable long-term architecture rule to repository and test guidance

Why

Repository instructions should reject knowingly temporary implementation paths.

Validation

• documentation-only diff check

Summary by CodeRabbit

• Documentation
  • Added guidance encouraging durable architectural decisions and discouraging temporary workarounds.
  • Applied the guidance to both general and testing-related contribution documentation.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 55e40b1b-c6e5-41e5-b3d7-0b31ff478a61

📥 Commits

Reviewing files that changed from the base of the PR and between b6bc767 and 5ed3ef1.

📒 Files selected for processing (2)

• AGENTS.md
• tests/AGENTS.md

📜 Recent review details

🧰 Additional context used

📓 Path-based instructions (8)

**/*.{py,md,rst,txt,yml,yaml,json,ini,env}

📄 CodeRabbit inference engine (CLAUDE.md)

Never fabricate, synthesize, forward-fill, interpolate, or default-fill missing market data in backtests; return empty / explicit absence instead, and remove any code that returns fake bars as real data.

Files:

• AGENTS.md
• tests/AGENTS.md

**/*.{png,jpg,jpeg,webp,gif,svg,md,rst}

📄 CodeRabbit inference engine (CLAUDE.md)

For any generated or AI-edited image or documentation visual, use Nano Banana MCP only; do not use fallback image generators, Mermaid screenshots, or manual diagram pipelines, and visually inspect every output before committing.

Files:

• AGENTS.md
• tests/AGENTS.md

**/*.{py,md,rst}

📄 CodeRabbit inference engine (CLAUDE.md)

If an environment variable is introduced or changed, make sure both engineering and public documentation stay synchronized with the new behavior.

Files:

• AGENTS.md
• tests/AGENTS.md

**/*

📄 CodeRabbit inference engine (AGENTS.md)

**/*: Never commit private, account-specific, machine-specific, or credential information to tracked repository files; use placeholders and rotate exposed credentials.
Never launch ThetaTerminal locally with production credentials; local debugging credentials must remain outside the repository and must not be used for backtests.
Never hardcode private downloader URLs; use placeholders or DATADOWNLOADER_BASE_URL.
Do not create new environment variables merely to skip tests or mask CI failures; use existing pytest markers and document genuinely required new variables in public and engineering environment-variable documentation.
Do not create or manage branches, pull requests, releases, deployments, tags, package publications, or downstream updates without explicit user authorization; never push directly to dev or switch branches without instruction.
Keep normal work on the canonical active version/X.Y.Z branch, avoid sibling worktrees and feature-branch chaining, preserve other agents' dirty changes, and commit coherent changes in logical chunks after reviewing diffs.
Never delete shared caches; use S3 namespace versioning for cold-cache simulations and delete cache objects only when explicitly requested and tightly scoped.
When making code changes, check and update both engineering documentation in docs/ and public documentation in docsrc/ as needed; document and test behavioral changes.
Use live broker behavior as the preferred measure of backtesting accuracy; vendor parity is only a regression signal, not absolute truth.
For customer-reported live broker execution problems, reproduce the exact deployed strategy, broker, asset class, order lifecycle, local state transitions, account selection, and complete logs before claiming resolution; simpler smoke tests are not proof.
Define and use North Star metrics and OKRs for project decisions, tracking leading indicators weekly and proposing metrics when none exist.
Make long-term architectural decisions rather than acc...

Files:

• AGENTS.md
• tests/AGENTS.md

**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Use uppercase underscore document names; date-first names are required for handoffs and investigations.

Files:

• AGENTS.md
• tests/AGENTS.md

**

⚙️ CodeRabbit configuration file

**: Review every pull request as if LumiBot is a public open-source trading framework.
Prioritize real bugs, security/privacy issues, user-facing regressions, and release risk.

Always check changed lines for:

• hardcoded credentials, API keys, tokens, account emails, private URLs, private hostnames, local credential paths, or personal filesystem paths;
• accidental leakage of BotSpot, Lumiwealth, customer, broker, paid-vendor, CI, or maintainer-only operational details into public code/docs/tests;
• code that logs, prints, persists, screenshots, or commits secrets or customer/broker data;
• test fixtures or docs that look fake but could be copied into real usage as credentials or private endpoints;
• changes that weaken authentication, authorization, data-source safety, broker/order safety, or CI/release gates.

If a finding depends on repository context, explain the specific source file and invariant instead of giving generic advice.

Files:

• AGENTS.md
• tests/AGENTS.md

AGENTS.md

⚙️ CodeRabbit configuration file

AGENTS.md: Treat this as a public open-source instruction file. Flag any private local paths,
credentials, account emails, private runbooks, Rob-specific folders, customer details,
or BotSpot/Lumiwealth-only operational instructions.

Files:

• AGENTS.md

tests/**

📄 CodeRabbit inference engine (tests/AGENTS.md)

tests/**: Treat tests whose earliest commit is before 2025-06-01 as LEGACY and tests whose earliest commit is before 2025-01-01 as FROZEN LEGACY; for legacy tests, fix the code rather than the test, with only documented and justified exceptions.
Any change to expected values or assertions in a test must include a nearby note explaining what changed and why the new expectation is correct; prefer making tests less brittle over updating magic numbers.

Files:

• tests/AGENTS.md

---

⚙️ CodeRabbit configuration file

tests/**: Tests are public. Flag hardcoded real-looking credentials, account emails, personal
paths, private endpoints, and fixtures that could accidentally exercise production or
paid-vendor resources without explicit opt-in.

Files:

• tests/AGENTS.md

🧠 Learnings (1)

📓 Common learnings

Learnt from: CR
Repo: Lumiwealth/lumibot

Timestamp: 2026-08-04T18:22:33.686Z
Learning: Make architectural decisions for the long term; do not accept stopgaps intended to be replaced later.

🔇 Additional comments (2)

AGENTS.md (1)

475-478: LGTM!

tests/AGENTS.md (1)

34-37: LGTM!

---

📝 Walkthrough

Walkthrough

Added “Long-Term Architecture” guidance to the main and test contributor instruction files. The guidance requires durable architectural decisions and discourages temporary implementations intended for later replacement.

Changes

Architecture Guidance

Layer / File(s)	Summary
Long-term architecture guidance AGENTS.md, tests/AGENTS.md	Added matching guidance that directs contributors toward durable architectural decisions instead of temporary replacements.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: grzesir

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the documentation change described in the pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/long-term-architecture-guidance

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}