Instruction file imported from DurdeuVlad/cs2-ai-data-coach (
.github/instructions/repo-cleanliness.instructions.md). Copyright stays with the author.
Repo Cleanliness Rules
This repository should always look clean and intentional on GitHub.
Non-negotiables
- Do not create new top-level files or folders unless they are clearly justified.
- Keep the repository root minimal and readable.
- Put implementation code in
src/, not in the root. - Put deterministic MCP logic in
src/mcp/and only thin wrappers inmcp/. - Put schemas in
src/schemas/. - Put tests in
tests/. - Put docs in
docs/. - Put prompts and agent adapters in
.ai/. - Put generated artifacts and AI-written outputs only in gitignored
data/paths.
Public GitHub Hygiene
- Never commit local caches, generated reports, stand-up outputs, logs, or secrets.
- Never use tracked docs folders for temporary notes or generated content.
- Prefer updating existing files over adding parallel docs or duplicate systems.
- If unsure where something belongs, do not place it in the root.
Working Style
- Make focused changes.
- Preserve readability for outside viewers.
- Keep naming straightforward and boring.
- Run
uv run pytest,uv run ruff check ., anduv run mypy srcafter meaningful changes.