Skip to content

added AGENTS.md#323

Merged
ospfranco merged 2 commits into
OP-Engineering:mainfrom
effect-native:docs/agents-md
Sep 15, 2025
Merged

added AGENTS.md#323
ospfranco merged 2 commits into
OP-Engineering:mainfrom
effect-native:docs/agents-md

Conversation

@subtleGradient

Copy link
Copy Markdown
Contributor

This pull request adds a new AGENTS.md documentation 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:

  • Added AGENTS.md with detailed guidelines on project structure, module organization, and file layout to clarify where code and assets should reside.
  • Documented build, test, and development commands, including prerequisites and steps for running the example app on iOS and Android.
  • Specified coding style and naming conventions for TypeScript, C/C++, Kotlin, and Objective‑C(++), including formatting requirements and enforcement tools.
  • Provided testing guidelines, emphasizing validation through the example app and type checking, and noted the absence of Jest tests.
  • Outlined commit and pull request standards, including message formatting, hygiene requirements, and PR content expectations.
  • Included architecture notes explaining the JSI TurboModule structure and feature flag configuration for the demo app.

Copilot AI review requested due to automatic review settings September 12, 2025 17:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CLAUDE.md
Comment thread AGENTS.md

## Coding Style & Naming Conventions

- TypeScript: Prettier enforced via `package.json` (single quotes, 2‑space

Copilot AI Sep 12, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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'.

Suggested change
- TypeScript: Prettier enforced via `package.json` (single quotes, 2space
- TypeScript: Prettier enforced via `package.json` (single quotes, 2-space

Copilot uses AI. Check for mistakes.
Comment thread AGENTS.md
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

Copilot AI Sep 12, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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(++)'.

Suggested change
- Kotlin/ObjC(++): Follow platform conventions and keep methods focused and
- Kotlin/Obj-C(++): Follow platform conventions and keep methods focused and

Copilot uses AI. Check for mistakes.
@ospfranco

ospfranco commented Sep 15, 2025

Copy link
Copy Markdown
Contributor

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.

@ospfranco ospfranco merged commit ade0174 into OP-Engineering:main Sep 15, 2025
8 checks passed
@subtleGradient subtleGradient deleted the docs/agents-md branch September 16, 2025 16:21
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.

3 participants