Add AGENTS.md onboarding file for coding agents

[Copilot]

Adds comprehensive onboarding instructions for coding agents (GitHub Copilot, Cursor, etc.) to reduce exploration time and build failures.

The instructions are located at /AGENTS.md in the root directory for maximum visibility and compatibility with various coding agents.

Contents

Repository context (~150 words):

• Tech stack: Svelte 5 + SvelteKit 2, TypeScript (non-strict), Vite 7, pnpm 10.15.1
• Project structure: ~1500 files, SvelteKit file-based routing, $lib/$routes/$themes aliases
• Testing: Vitest (unit) + Playwright (e2e)

Critical build steps (~250 words):

• pnpm setup requirements (corepack, specific version)
• .env file creation from template (required before dev/build)
• Network access configuration: Firewall/proxy setup for pkg.pr.new, pkg.vc, registry.npmjs.org domains integrated into Setup section step 3
• GitHub Actions guidance: use pnpm/action-setup@v4 for registry configuration
• Proxy configuration commands and troubleshooting steps
• Command sequence with timing: check (~30-60s) → lint (~10-20s) → test (~10-30s) → build (~60-120s)
• CI pipeline replication steps

Common pitfalls (~200 words):

• Network deps (pkg.pr.new/pkg.vc) may fail - includes troubleshooting with curl commands and proxy setup for local development
• Tests require TZ=EST (timezone-sensitive)
• Memory limits: set NODE_OPTIONS=--max_old_space_size=8192 for builds
• Dev server blank page: disable ad blockers
• Format before lint to avoid conflicts

Code conventions (~100 words):

• Import aliases, component organization, TypeScript usage patterns
• SvelteKit routing conventions (+page.svelte, +layout.ts, etc.)
• Configuration file purposes (svelte.config.js, vite.config.ts, tsconfig.json, etc.)

Workflow (~100 words):

• Development workflow steps from backend setup through testing
• Screenshot requirement: Agents must capture and include screenshots for any UI changes in PR description or comments before finalizing

Total: 796 words, fits within 2-page limit.

File Location

The instructions are located at /AGENTS.md in the root directory, making them discoverable by:

• GitHub Copilot
• Cursor
• Other AI coding assistants that look for agent instructions in the repository root

Screenshot

The screenshot shows the complete AGENTS.md file with all sections including the workflow step that instructs agents to take screenshots of UI changes.

Original prompt

Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.

You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.

- Reduce the likelihood of a coding agent pull request getting rejected by the user due to generating code that fails the continuous integration build, fails a validation pipeline, or having misbehavior. - Minimize bash command and build failures. - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools. - Instructions must be no longer than 2 pages. - Instructions must not be task specific.

Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:

• A summary of what the repository does.
• High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.

Add information about how to build and validate changes so the agent does not need to search and find it each time.

• For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
• Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
• Try cleaning the repo and environment and running commands in different orders and document errors and and misbehavior observed as well as any steps used to mitigate the problem.
• Run the tests and document the order of steps required to run the tests.
• Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
• Document environment setup steps that seem optional but that you have validated are actually required.
• Document the time required for commands that failed due to timing out.
• When you find a sequence of commands that work for a particular purpose, document them in detail.
• Use language to indicate when something should always be done. For example: "always run npm install before building".
• Record any validation steps from documentation.

List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.

• A description of the major architectural elements of the project, including the relative paths to the main project files, the location
  of configuration files for linting, compilation, testing, and preferences.
• A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
• Document the steps so that the agent can replicate these itself.
• Any explicit validation steps that the agent can consider to have further confidence in its changes.
• Dependencies that aren't obvious from the layout or file structure.
• Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
  contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.

- Perform a comprehensive inventory of the codebase. Search for and view: - README.md, CONTRIBUTING.md, and all other documentation files. - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc. - All scripts, particularly those pertaining to build and repo or environment setup. - All build and actions pipelines. - All project files. - All configuration and linting files. - For each file: - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change? - If yes: - Document the command or information in detail. - Explicitly indicate which commands work and which do not and the order in which commands should be run. - Document any errors encountered as well as the steps taken to workaround them. - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands. - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instruction...

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[railway-app]

This PR was not deployed automatically as @Copilot does not have access to the Railway project.

In order to get automatic PR deploys, please add @Copilot to your workspace on Railway.

[appwrite]

Console

Project ID: 688b7bf400350cbd60e9

Sites (1)

Site	Status	Logs	Preview	QR
console-stage 688b7cf6003b1842c9dc	Ready	View Logs	Preview URL

Tip

Appwrite has a Discord community with over 16 000 members.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[stnguyen90]

@copilot Add action setup steps to ensure firewall doesn't block the following

• pkg.pr.new
• pkg.vc

Additionally, include anything else that might be relevant in the setup

[Copilot]

@copilot Add action setup steps to ensure firewall doesn't block the following

• pkg.pr.new
  ...

Added network access configuration in commit 300b435:

Setup section (step 3):

• Lists required domains: pkg.pr.new, pkg.vc, registry.npmjs.org
• Specifies which dependencies need these domains
• GitHub Actions guidance: use pnpm/action-setup@v4
• Proxy check commands: npm config get proxy

Common Pitfalls section (#2):

• Domain accessibility check: curl -I https://pkg.pr.new
• Proxy configuration: npm config set proxy http://proxy:port
• Runner access requirements for GitHub Actions
• Fallback info for cached versions

[stnguyen90]

@copilot no, the firewall for and pkg.pr.new, pkg.vc should go into GitHub action setup as mentioned in https://gh.io/copilot/actions-setup-steps

[Copilot]

@copilot no, the firewall for and pkg.pr.new, pkg.vc should go into GitHub action setup as mentioned in https://gh.io/copilot/actions-setup-steps

Moved firewall configuration to dedicated "GitHub Actions Setup" section in commit 299573f.

New structure:

• Separate section after Setup with clear firewall allowlist format
• Lists required domains: pkg.pr.new, pkg.vc, registry.npmjs.org
• Maps each domain to specific dependencies
• Includes action configuration YAML example with pnpm/action-setup@v4
• Troubleshooting for ENOTFOUND errors

GitHub Actions specific guidance removed from general setup steps and Common Pitfalls.

[stnguyen90]

@copilot Never mind. Remove thr GitHub action setup change

[Copilot]

@copilot Never mind. Remove thr GitHub action setup change

Removed GitHub Actions Setup section in commit 73e9b82. Reverted to the previous structure with network access configuration in Setup section step 3.

[stnguyen90]

@copilot update the agent workflow to take a screenshot of the changes and include it in the PR before finishing.

[Copilot]

@copilot update the agent workflow to take a screenshot of the changes and include it in the PR before finishing.

Added screenshot instruction to workflow section in commit 4ab3df1.

Step 6 now instructs agents: "Take screenshots: For any UI changes, capture screenshots and include them in the PR description or comments before finalizing"

[stnguyen90]

@copilot, let's rename the copilot-instructions.md to AGENTS.md and move it to the root directory so that it can be picked up by other coding agents like Cursor

[Copilot]

@copilot, let's rename the copilot-instructions.md to AGENTS.md and move it to the root directory so that it can be picked up by other coding agents like Cursor

Renamed and moved to root directory in commit 4b411b0. The file is now located at /AGENTS.md and can be picked up by Cursor and other coding agents.