added AGENTS.md#323
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation to help contributors understand the codebase structure and development workflow. The documentation covers project organization, build processes, coding standards, and architectural patterns.
Key changes:
- Added detailed contributor guidelines covering project structure, build commands, and coding conventions
- Documented testing approach and commit/PR standards
- Included architecture notes explaining the JSI TurboModule implementation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CLAUDE.md | Simple reference file pointing to the main documentation |
| AGENTS.md | Comprehensive contributor guidelines covering project structure, development workflow, coding standards, and architecture |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| ## Coding Style & Naming Conventions | ||
|
|
||
| - TypeScript: Prettier enforced via `package.json` (single quotes, 2‑space |
There was a problem hiding this comment.
The character used for the dash in '2‑space' appears to be a non-breaking hyphen (U+2011) instead of a regular hyphen. This should be changed to a regular hyphen for consistency: '2-space'.
| - TypeScript: Prettier enforced via `package.json` (single quotes, 2‑space | |
| - TypeScript: Prettier enforced via `package.json` (single quotes, 2-space |
| PascalCase for types/classes. Keep strict typing; fix unused vars/params. | ||
| - C/C++: `.clang-format` (LLVM style, 4‑space indent). Run | ||
| `yarn clang-format-check` before pushing. | ||
| - Kotlin/Obj‑C(++): Follow platform conventions and keep methods focused and |
There was a problem hiding this comment.
The character used for the dash in 'Obj‑C(++)' appears to be a non-breaking hyphen (U+2011) instead of a regular hyphen. This should be changed to a regular hyphen for consistency: 'Obj-C(++)'.
| - Kotlin/Obj‑C(++): Follow platform conventions and keep methods focused and | |
| - Kotlin/Obj-C(++): Follow platform conventions and keep methods focused and |
|
I despise the AI slop. Even on this PR it makes non-sensical comments. But w/e I cannot fight the current wave of AI hype, I hope at least it guides the stupid machine to more workable commits. |
This pull request adds a new
AGENTS.mddocumentation file that outlines repository guidelines for project structure, build and test commands, coding style, testing practices, commit conventions, and architecture notes. This will help contributors quickly understand how to work with the codebase and maintain consistency.Documentation improvements:
AGENTS.mdwith detailed guidelines on project structure, module organization, and file layout to clarify where code and assets should reside.