AGENTS.md

1## Global instructions
2 
3- When refactoring existing code, check relevant files for existing tests and update them if necessary.
4- When adding new code, prefer to write easily mockable and testable code, and include tests where applicable.
5- Limit the amount of comments you put in the code to a strict minimum. You should almost never add comments, except sometimes on non-trivial code, function definitions if the arguments aren't self-explanatory, and class definitions and their members.
6- Do not remove existing comments unless they are directly related to what you are changing.
7 
8## Repository Structure
9 
10This is a monorepo containing three main projects:
11 
12- `firefox-ios/` - Firefox for iOS (main app, scheme: `Fennec`)
13- `focus-ios/` - Firefox Focus for iOS (scheme: `Focus`)
14- `BrowserKit/` - Shared Swift Package mostly used in Firefox
15 
16## Common Commands
17 
18### Build & Test
19 
20```bash
21# Build for testing (Firefox)
22fxios test
23```
24 
25### JavaScript User Scripts
26 
27Needed to be ran whenever we make JavaScript changes.
28 
29```bash
30npm run build   # production build
31npm run dev     # watch mode with source maps
32```
33 
34### Linting
35 
36SwiftLint runs automatically via Xcode build phases on the Client target. Install via `brew install swiftlint`. Configuration is in `.swiftlint.yml`.
37SwiftLint also runs whenever code is pushed to the remote, using hooks.
38 
39### Pull requests
40 
41Pull requests needs to be opened with the provided `PULL_REQUEST_TEMPLATE`. Update relevant section. 
42GitHub ticket number can be found at the bottom of the JIRA ticket.
43 
44## Runbooks
45 
46- **Xcode version upgrade.** When bumping the Xcode version used by CI/local builds, follow [docs/xcode-upgrade.md](docs/xcode-upgrade.md).