Add .github/copilot-instructions.md for agent onboarding

[Copilot]

Onboarding document to reduce agent exploration time and build failures.

Content

Build & Environment

• PUPPETEER_SKIP_DOWNLOAD=1 npm ci requirement (puppeteer Chrome download fails)
• Build sequence: npm run build required before tests (~5s)
• Dev server: npm run dev on port 4000
• CI requirement: AppArmor disable for puppeteer

Project Structure

• Monorepo: 4 packages (yasgui, yasqe, yasr, utils)
• Build configs: 4 tsconfig files, esbuild.config.js, vite.config.ts
• Output: build/ directory with IIFE bundles + per-package distributions

Common Issues & Workarounds

• Puppeteer network failures → PUPPETEER_SKIP_DOWNLOAD
• Test failures → build first (pretest checks for build output)
• ESLint pattern warning → expected (tests in root, not per-package)
• TypeScript validation errors → expected (missing @types for dependencies)

Validation Checklist

• Commands: build, lint, validateTs, test, prettify
• Expected warnings documented with explanations

File Stats

215 lines, 1113 words, 8.1KB (within 2-page limit)

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:

• googlechromelabs.github.io
  • Triggering command: /usr/local/bin/node node install.mjs (dns block)
• https://storage.googleapis.com/chrome-for-testing-public/142.0.7444.175/linux64/chrome-linux64.zip
  • Triggering command: /usr/local/bin/node node install.mjs (http 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...

---

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

[MathiasVDA]

@copilot make sure that 'conventional commit messages' are used

[Copilot]

@copilot make sure that 'conventional commit messages' are used

You're right. The commit messages should follow conventional commit format. The current commits should be:

1. doc: add initial plan for copilot-instructions (8485aa2)
2. docs: add copilot-instructions.md for agent onboarding (7901542)
3. docs: address code review feedback on copilot-instructions (0ee98bd)

Since these commits are already pushed, amending them requires force-pushing which is outside my capabilities. The commit messages can be corrected by rebasing interactively (git rebase -i HEAD~3) and rewording them, then force-pushing the branch.

[Copilot]

Pull request overview

This PR adds a comprehensive onboarding document (.github/copilot-instructions.md) to help Copilot coding agents work efficiently with the YASGUI repository by reducing exploration time and preventing common build failures.

Key changes:

• Documents critical build requirements (PUPPETEER_SKIP_DOWNLOAD environment variable, build-before-test sequence)
• Provides monorepo architecture overview with package dependencies and build configurations
• Includes troubleshooting guide for common issues (puppeteer failures, AppArmor restrictions, expected warnings)

[Copilot]

The phrase "No files matching packages//test/**/.{ts,tsx}" is missing the word "pattern" that appears in the actual warning message on line 158. For consistency and accuracy, this should match the exact warning text: "No files matching the pattern 'packages//test/**/.{ts,tsx}' were found".

Suggested change

	2. **Lint:** `npm run util:lint` (will show "No files matching packages/*/test/**/*.{ts,tsx}" - this is expected as tests are in root test/ directory, not per-package)
	2. **Lint:** `npm run util:lint` (will show "No files matching the pattern 'packages/*/test/**/*.{ts,tsx}' were found" - this is expected as tests are in root test/ directory, not per-package)

[Copilot]

The last four sections ("Commit messages", "Documentation", "Screenshots", "Run tests") are very brief and somewhat redundant with earlier content. Lines 230-231 duplicate the testing advice already given in lines 52-66 and line 196. Lines 222-224 add little value beyond stating to "update docs as needed". Consider removing these sections or consolidating them into a more comprehensive "Development Workflow" section to avoid redundancy and better use the limited 2-page space.

Suggested change

	## Commit messages
	- Use conventional commits (feat:, fix:, docs:, style:, refactor:, test:, chore:)
	## Documentation
	- Update docs in `docs/` as needed
	## Screenshots
	- Include screenshots in pull request communication when UI changes are made
	## Run tests
	- Ensure tests pass locally before pushing changes
	## Development Workflow
	- Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages (e.g., `feat:`, `fix:`, `docs:`, `style:`, `refactor:`, `test:`, `chore:`)
	- Update documentation in `docs/` when relevant changes are made
	- Include screenshots in pull requests when making UI changes
	- Ensure all tests pass locally before pushing changes

[Copilot]

The term "gitignored" should be hyphenated as "git-ignored" for proper spelling, or use the more standard phrasing "ignored by git".

Suggested change

	├── build/ # Build output (gitignored, created by npm run build)
	├── build/ # Build output (ignored by git, created by npm run build)

[Copilot]

The term "gitignored" should be hyphenated as "git-ignored" for proper spelling, or use the more standard phrasing "ignored by git".

Suggested change

	- Build artifacts are gitignored - never commit `build/` directory
	- Build artifacts are ignored by git - never commit `build/` directory