Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds an AGENTS.md file to help AI agents (like GitHub Copilot) understand the Simorgh codebase structure, conventions, and best practices. The file is based on a suggestion from a Twitter/X post and aims to reduce common mistakes and confusion points that AI agents might encounter when working on this project.
Changes:
- Added AGENTS.md with project overview, dev environment tips, coding standards, testing instructions, and PR instructions
- Documents service-aware architecture pattern where each language service (e.g., arabic, mundo, portuguese) can have different requirements
- Provides guidance on accessibility, performance optimization, and functional programming approach
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| ## Coding Standards | ||
| - See docs/Coding-Standards/README.md for our coding standards. These can be seen implemented in bbc/simorgh/src/app/components/Paragraph/.* along with linting rules in .eslintrc.js | ||
| - Please use the CONTRIBUTING.md and SECURITY.md |
There was a problem hiding this comment.
The "Coding Standards" section header is duplicated - it already appears on line 18. Additionally, the content in these two sections is similar but inconsistent (line 19 mentions "src/app/components/Paragraph/" while line 25 mentions "bbc/simorgh/src/app/components/Paragraph/.*", and line 20 says "read and follow the guidelines" while line 26 says "Please use"). These duplicate sections should be merged into a single, consistent section.
| - Use `nvm use` to get the correct version of node, and then `yarn` install packages. Then `yarn dev` will serve your code locally. | ||
| - Our directory aliases can be found in dirAlias.js |
There was a problem hiding this comment.
This content is duplicated from lines 15-16. The development environment tips are being repeated, which creates confusion and inconsistency in the documentation.
Based on https://x.com/theo/status/2025900730847232409?s=20 there is another bit that could do with adding