Skip to content

chore: add AGENTS.md, git workflow rule, and expand README architecture - #4

Merged
chapati23 merged 4 commits into
mainfrom
chore/agent-docs
Feb 22, 2026
Merged

chore: add AGENTS.md, git workflow rule, and expand README architecture#4
chapati23 merged 4 commits into
mainfrom
chore/agent-docs

Conversation

@gisk0

@gisk0 gisk0 commented Feb 22, 2026

Copy link
Copy Markdown
Collaborator

Why

Postmortem from building the App Store subsections feature. Key friction points that docs can fix:

  • Finding the project: multiple search timeouts before locating it
  • Understanding architecture: had to cold-read 5 source files before writing code
  • Git rule violation: pushed directly to main (no cursor rule enforcing PRs)
  • Unused import on push: trunk caught it on push; should catch pre-commit

What's Added

.cursor/rules/git-workflow.mdc (alwaysApply: true)

Enforces branch + PR workflow. Never push directly to main.

AGENTS.md

Full code guide for agents and developers:

  • Data flow diagram (DataSource → orchestrator → Telegram)
  • Key files table with one-line descriptions
  • All sources with what they fetch
  • BriefingItem rendering reference (sentimentPrefix, monospace, url patterns)
  • How to add a new source (including the mock pattern)
  • Local dev commands
  • Test coverage map (source file → test file)
  • Reminder to run trunk before committing, not just before pushing

README.md

Expands Architecture section from infrastructure-only to include code structure tree and data flow summary.

gisk0 and others added 4 commits February 22, 2026 10:34
- AGENTS.md: full code guide for agents — data flow, key files, BriefingItem
  rendering patterns, how to add a new source, test coverage map, dev commands
- .cursor/rules/git-workflow.mdc: alwaysApply rule enforcing branch+PR workflow
- README.md: expand Architecture section with code structure tree and data flow
@chapati23
chapati23 merged commit f5a319b into main Feb 22, 2026
2 checks passed
@chapati23
chapati23 deleted the chore/agent-docs branch February 22, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants