-
Notifications
You must be signed in to change notification settings - Fork 48
docs: add repository guidelines for agents #68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds AGENTS.md to document concise repository guidelines for automation agents.
- Introduces project structure summary and common build/test/release commands.
- Provides coding style, testing, and commit/PR conventions targeted at automated contributors.
| Run automation from the repository root; Fastlane expects valid App Store Connect credentials in your environment. | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Follow Swift API Design Guidelines: `UpperCamelCase` for types, `lowerCamelCase` for values, and keep file-per-feature modules consistent with existing folders (e.g., add Feed views under `V2er/View/Feed/`). |
Copilot
AI
Oct 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The phrase 'file-per-feature modules' is ambiguous (could mean one file per feature or a directory-per-feature). Suggest rewording to clarify intent, e.g., 'keep each feature's views grouped under its existing folder (e.g., place new Feed views in V2er/View/Feed/).'
| - Follow Swift API Design Guidelines: `UpperCamelCase` for types, `lowerCamelCase` for values, and keep file-per-feature modules consistent with existing folders (e.g., add Feed views under `V2er/View/Feed/`). | |
| - Follow Swift API Design Guidelines: `UpperCamelCase` for types, `lowerCamelCase` for values, and keep each feature's views grouped under its existing folder (e.g., place new Feed views in `V2er/View/Feed/`). |
| ## Testing Guidelines | ||
| - Mirror production code structure inside `V2erTests/`; create `FeatureNameTests.swift` alongside the feature reducer or service you touch. | ||
| - Use `xcodebuild test` (above) for local validation; set destinations to match CI simulators (iPhone 14, iOS 17) to avoid config drift. | ||
| - When adding UI work, include a smoke scenario in `V2erUITests/` or capture simulator screenshots for PR reviewers if automation is impractical. |
Copilot
AI
Oct 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] UI test guidance omits how to name UI test files and whether to use test plans. Consider adding an explicit naming convention (e.g., FeatureNameUITests.swift) and clarifying if a Test Plan is required, improving consistency for automation agents.
| - When adding UI work, include a smoke scenario in `V2erUITests/` or capture simulator screenshots for PR reviewers if automation is impractical. | |
| - When adding UI work, include a smoke scenario in `V2erUITests/` (name UI test files as `FeatureNameUITests.swift` for consistency) or capture simulator screenshots for PR reviewers if automation is impractical. If automating UI tests, use an Xcode Test Plan (`V2erUITests.xctestplan`) to organize scenarios unless the feature is trivial; this improves CI reliability and agent automation. |
| - When adding UI work, include a smoke scenario in `V2erUITests/` or capture simulator screenshots for PR reviewers if automation is impractical. | ||
|
|
||
| ## Commit & Pull Request Guidelines | ||
| - Adopt the conventional short prefix format from history, e.g., `chore: bump version to 1.1.18` or `fix(auth): handle MFA token refresh`; keep messages in English and under 72 characters. |
Copilot
AI
Oct 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Commit guideline references 'conventional short prefix format' without enumerating allowed prefixes, which can lead to inconsistency. Recommend listing accepted prefixes (e.g., feat, fix, chore, docs, test, refactor, perf, ci) for clarity.
| - Adopt the conventional short prefix format from history, e.g., `chore: bump version to 1.1.18` or `fix(auth): handle MFA token refresh`; keep messages in English and under 72 characters. | |
| - Adopt the conventional short prefix format (accepted prefixes: `feat`, `fix`, `chore`, `docs`, `test`, `refactor`, `perf`, `ci`) as used in history, e.g., `chore: bump version to 1.1.18` or `fix(auth): handle MFA token refresh`; keep messages in English and under 72 characters. |
Code Coverage Report ❌Current coverage: 15.06% |
Summary
Testing