github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-05-11 09:38:37 -05:00
Code Issues 1.6k Packages Projects Releases 57 Wiki Activity

[PR #5942] [MERGED] docs: add AGENTS.md guide for AI agents #40655

New Issue
Closed
opened 2026-04-23 13:28:56 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-23 13:28:56 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/5942
Author: @MatissJanis
Created: 10/16/2025
Status: ✅ Merged
Merged: 10/17/2025
Merged by: @MatissJanis

Base: master ← Head: docs/add-agents-guide

📝 Commits (3)

  • b811da7 docs: add AGENTS.md guide for AI agents
  • 9ead4bc docs: add release notes for AGENTS.md file
  • be63a0b Delete .cursor/rules directory

📊 Changes

5 files changed (+544 additions, -63 deletions)

View changed files

➖ .cursor/rules/commands.mdc (+0 -12)
➖ .cursor/rules/typescript.mdc (+0 -37)
➖ .cursor/rules/unit-tests.mdc (+0 -14)
➕ AGENTS.md (+538 -0)
➕ upcoming-release-notes/5942.md (+6 -0)

📄 Description

This PR adds a comprehensive AGENTS.md file to help AI agents (like Cursor) work effectively with the Actual Budget codebase.

What's included:

  • Project Overview: Description of Actual Budget, repository structure, and links
  • Quick Start Commands: Essential commands for development, testing, and linting
  • Architecture & Package Structure: Detailed breakdown of all 9 packages in the monorepo
  • Development Workflow: Best practices for making changes, testing, and type checking
  • Code Style & Conventions: TypeScript/React patterns, naming conventions, and forbidden patterns
  • File Structure Patterns: Example component and test file structures
  • Important Directories & Files: Where to find key files and what to avoid editing
  • Common Development Tasks: Recipes for frequent operations
  • Troubleshooting: Solutions to common issues (type errors, linter errors, test failures, etc.)
  • Testing Patterns: Unit, E2E, and visual regression testing guidelines
  • Code Quality Checklist: What to verify before committing
  • Pull Request Guidelines: Notes about labeling AI-generated PRs

This guide will be particularly useful for AI coding assistants to understand the project structure, conventions, and best practices without needing to explore the codebase extensively.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/5942 **Author:** [@MatissJanis](https://github.com/MatissJanis) **Created:** 10/16/2025 **Status:** ✅ Merged **Merged:** 10/17/2025 **Merged by:** [@MatissJanis](https://github.com/MatissJanis) **Base:** `master` ← **Head:** `docs/add-agents-guide` --- ### 📝 Commits (3) - [`b811da7`](https://github.com/actualbudget/actual/commit/b811da711abfa92f7c11d47c96317816a96a5c6f) docs: add AGENTS.md guide for AI agents - [`9ead4bc`](https://github.com/actualbudget/actual/commit/9ead4bc0bab21967da42427eef870fb50e492be9) docs: add release notes for AGENTS.md file - [`be63a0b`](https://github.com/actualbudget/actual/commit/be63a0b45160773c591e475121eea1516b56443e) Delete .cursor/rules directory ### 📊 Changes **5 files changed** (+544 additions, -63 deletions) <details> <summary>View changed files</summary> ➖ `.cursor/rules/commands.mdc` (+0 -12) ➖ `.cursor/rules/typescript.mdc` (+0 -37) ➖ `.cursor/rules/unit-tests.mdc` (+0 -14) ➕ `AGENTS.md` (+538 -0) ➕ `upcoming-release-notes/5942.md` (+6 -0) </details> ### 📄 Description This PR adds a comprehensive AGENTS.md file to help AI agents (like Cursor) work effectively with the Actual Budget codebase. ## What's included: - **Project Overview**: Description of Actual Budget, repository structure, and links - **Quick Start Commands**: Essential commands for development, testing, and linting - **Architecture & Package Structure**: Detailed breakdown of all 9 packages in the monorepo - **Development Workflow**: Best practices for making changes, testing, and type checking - **Code Style & Conventions**: TypeScript/React patterns, naming conventions, and forbidden patterns - **File Structure Patterns**: Example component and test file structures - **Important Directories & Files**: Where to find key files and what to avoid editing - **Common Development Tasks**: Recipes for frequent operations - **Troubleshooting**: Solutions to common issues (type errors, linter errors, test failures, etc.) - **Testing Patterns**: Unit, E2E, and visual regression testing guidelines - **Code Quality Checklist**: What to verify before committing - **Pull Request Guidelines**: Notes about labeling AI-generated PRs This guide will be particularly useful for AI coding assistants to understand the project structure, conventions, and best practices without needing to explore the codebase extensively. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-23 13:28:56 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#40655
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?