docs: add comprehensive copilot-instructions.md for repository onboarding

[Copilot]

Overview

Added .github/copilot-instructions.md to onboard GitHub Copilot coding agents to the near-api-js repository. This file provides comprehensive, validated instructions that enable agents to work efficiently without extensive exploration on each task.

What's Included

The instructions file covers:

Repository Overview

• TypeScript monorepo structure with 16 packages
• Technology stack: pnpm 10.4.1, Node >=20.18.3, Turborepo 2.4.4
• Onion architecture design (types/utils → crypto/providers/transactions → accounts/signers/keystores)

Critical Build & Environment Requirements

• Step-by-step setup with exact command sequences
• Validated timing expectations: 40-60s builds, 3-5min tests
• E2E test handling: Special --ignore-workspace flag requirement
• Dependency order: Build orchestration via Turborepo

Complete CI/CD Pipeline Documentation

• PR check workflow (install → build → lint → test → check-exports → e2e)
• Release workflow using Changesets
• Git hooks (commit-msg validation, pre-push linting)

Development Workflows

• File organization standards (source, tests, build outputs)
• Build system details (tsup with dual ESM/CJS outputs)
• Testing guidelines (Jest for unit tests, Vitest for e2e)
• Linting configuration (ESLint with TypeScript, 4-space indent)

Known Issues & Workarounds

Documented 6 common issues with solutions:

• Cookbook build output warnings (expected, safe to ignore)
• Native module build script warnings (pre-built, safe to ignore)
• E2E workspace flag requirement (critical for proper testing)
• ts-jest version warnings (works correctly despite warning)
• Clean/build dependencies (must rebuild after clean)
• Turborepo caching behavior (clear .turbo if stale)

Changesets Workflow

Complete guide for version management when making changes

Validation

All commands documented were executed and validated:

• ✅ Fresh install and build from clean state
• ✅ Lint passes with expected warnings
• ✅ All unit tests passing
• ✅ Package export validation working
• ✅ E2E tests with proper workspace handling

Benefits

This onboarding file will help coding agents:

1. Reduce exploration time by providing architecture and file locations upfront
2. Minimize build failures with validated command sequences and timing
3. Avoid common pitfalls through documented issues and workarounds
4. Align with CI by mirroring the exact CI pipeline locally
5. Work faster with clear workflows from setup to submission

The instructions are concise (~1,300 words), task-agnostic, and focused on reducing the likelihood of rejected PRs due to build failures or incorrect workflows.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• rpc.testnet.near.org
  • Triggering command: /usr/local/bin/node /home/REDACTED/work/near-api-js/near-api-js/node_modules/.pnpm/[email protected]/node_modules/jest-worker/build/workers/processChild.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

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

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9442338

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR