GitHub Copilot Instructions

May 10, 2026 · View on GitHub

What matters most in this repo

When generating code for this repository:

Respect the exact toolchain versions in package.json.
Treat .github/instructions/ngx-vest-forms.instructions.md as the always-on invariant sheet for ngx-vest-forms usage.
Treat .github/instructions/vest.instructions.md as the deeper Vest validation guide.
Use the umbrella ngx-vest-forms skill and its nested workflow sub-skills for feature workflows instead of restating library docs from memory.
Prefer patterns already present in the repo over generic framework advice.

This repo maintains parallel release lines. Pick the right base branch before proposing changes.

master — current stable v2 maintenance line. Only target master for v2 bug fixes, security patches, or repo-wide governance/tooling changes that must apply to the default branch (PR templates, dependabot config, copilot instructions, CI policy). Do not target master for new v3 features or refactors.
release/v3 — active v3 development. All v3 features, refactors, test migrations, and v3-specific dependency upgrades target this branch. Merging here does not auto-publish; v3 only ships via manual workflow_dispatch of .github/workflows/prerelease.yml (snapshot prereleases) — never on PR merge.
Other release/* branches are maintenance-only for their respective majors.

When uncertain, default to release/v3 and call out the choice in the PR description so a reviewer can redirect if needed.

Do not suggest code that depends on newer language or framework features than these versions support.

When writing examples for developers using the library:

import from 'ngx-vest-forms'
prefer symbols that exist in projects/ngx-vest-forms/src/public-api.ts
do not recommend imports from projects/ngx-vest-forms/src/lib/** or other internal paths unless the task is explicitly about maintaining the library itself

If a new library feature is added, export it in projects/ngx-vest-forms/src/public-api.ts and then update the examples, docs, and skills.

Keep name aligned with the [ngModel] path.
Use [ngModel], not [(ngModel)], for ngx-vest-forms examples.
Use optional chaining with partial form models.
Call only(field) unconditionally in Vest suites.
Use vestFormsViewProviders in child form components that participate in the parent form tree.

These rules live in the invariant instruction file; correct violations instead of arguing with them.

Need the baseline rules: read .github/instructions/ngx-vest-forms.instructions.md
Need Vest suite semantics: read .github/instructions/vest.instructions.md
Need default form setup: use the core/ workflow sub-skill under ngx-vest-forms
Need validationConfig guidance: use the validation-config-builder/ workflow sub-skill under ngx-vest-forms
Need ROOT_FORM: use the root-form-validation/ workflow sub-skill under ngx-vest-forms
Need wrappers: use the built-in-wrappers/ or custom-wrapper-patterns/ workflow sub-skill under ngx-vest-forms
Need composite adapter (one widget, multiple fields): use the composite-adapter/ workflow sub-skill under ngx-vest-forms
Need nested sections: use the child-components/ workflow sub-skill under ngx-vest-forms
Need dynamic structure changes: use the dynamic-form-behavior/ workflow sub-skill under ngx-vest-forms

When changing the library itself: