| 1 | <!-- nx configuration start--> |
| 2 | <!-- Leave the start & end comments to automatically receive updates. --> |
| 3 | |
| 4 | # General Guidelines for working with Nx |
| 5 | |
| 6 | - When running tasks (for example build, lint, test, e2e, etc.), always prefer running the task through `nx` (i.e. `nx run`, `nx run-many`, `nx affected`) instead of using the underlying tooling directly |
| 7 | - You have access to the Nx MCP server and its tools, use them to help the user |
| 8 | - When answering questions about the repository, use the `nx_workspace` tool first to gain an understanding of the workspace architecture where applicable. |
| 9 | - When working in individual projects, use the `nx_project_details` mcp tool to analyze and understand the specific project structure and dependencies |
| 10 | - For questions around nx configuration, best practices or if you're unsure, use the `nx_docs` tool to get relevant, up-to-date docs. Always use this instead of assuming things about nx configuration |
| 11 | - If the user needs help with an Nx configuration or project graph error, use the `nx_workspace` tool to get any errors |
| 12 | - For Nx plugin best practices, check `node_modules/@nx/<plugin>/PLUGIN.md`. Not all plugins have this file - proceed without it if unavailable. |
| 13 | |
| 14 | <!-- nx configuration end--> |
| 15 | |
| 16 | ## Agent skills |
| 17 | |
| 18 | ### Issue tracker |
| 19 | |
| 20 | Issues and PRDs are tracked as local markdown files under `.scratch/`, not GitHub Issues. See `docs/agents/issue-tracker.md`. |
| 21 | |
| 22 | ### Triage labels |
| 23 | |
| 24 | Triage uses Chinese status strings for the local markdown tracker. See `docs/agents/triage-labels.md`. |
| 25 | |
| 26 | ### Domain docs |
| 27 | |
| 28 | This repo uses a multi-context domain documentation layout. See `docs/agents/domain.md`. |
| 29 |