Repository navigation
Add AGENTS.md - #261
Add AGENTS.md#261huntie wants to merge 1 commit into
Conversation
|
@cortinico @cipolleschi Trying my best here to be both minimal + ecosystem agnostic with this first draft. This guidance becomes the default for everyone, so let's review thoroughly! |
|
The updated commit aligns to what I was trying to convey. Thanks @huntie for this! |
|
|
||
| It does not include Expo: `npx expo` commands and `expo-*` packages need `npx install-expo-modules` first, so don't use them unless asked. | ||
|
|
||
| ## Commands |
There was a problem hiding this comment.
I'd say this is too trivial to be added to AGENTS.md.
Making sure we have a clear package.json list of commands should make it redundant, for this end let's consider adding npm run clear that does whatever is mentioned below.
|
|
||
| - `ios/` and `android/` are source code, edited directly and committed, not generated. | ||
| - JavaScript and TypeScript changes reach a running app through Fast Refresh. Native changes, and adding or removing packages with native code, need a rebuild. | ||
| - Check APIs against the docs for the React Native version in `package.json` ([reactnative.dev](https://reactnative.dev/docs/getting-started)). Many examples online use deprecated APIs, such as `SafeAreaView` from `react-native`; use `react-native-safe-area-context` instead. |
There was a problem hiding this comment.
Follow up to consider: Would be better if all APIs are documented inside the repo instead like what we did with Metro.
|
|
||
| ## Rules | ||
|
|
||
| - `ios/` and `android/` are source code, edited directly and committed, not generated. |
There was a problem hiding this comment.
I'm not sure the first two lines are needed. This is known by LLMS for sure by now.
Summary
Add an
AGENTS.mdto new apps, so coding agents get the project commands and avoid the mistakes they commonly make in a Community CLI app. It stays tool-agnostic, per the discussion in #175.Resolves #175
Changelog:
[General][Added] - Template:
AGENTS.mdwith guidance for coding agentsTest Plan
prettier --check template/AGENTS.mdpasses.npm run iosinstalling CocoaPods itself, andstart --reset-cache, checked against the Community CLI source and docs.