chore: add GitHub Copilot instructions #11781

Copilot · 2025-11-19T19:52:26Z

Setting up GitHub Copilot instructions for the TypeORM repository

Create .github/copilot-instructions.md file
Document repository structure and architecture
Document coding standards and conventions
Document testing practices
Document build and development workflow
Document database-specific considerations
Document contribution guidelines reference
Review and validate the instructions
Address PR feedback:
- Simplified TypeScript configuration section (removed strict mode and reflect-metadata notes)
- Added preference for functional tests over per-issue tests
- Simplified test guidance to focus only on preferring functional tests

Summary

Successfully created comprehensive GitHub Copilot instructions for the TypeORM repository. The instructions file includes:

Coverage

Project Overview: Description of TypeORM as a multi-database ORM supporting Active Record and Data Mapper patterns
Architecture & Structure: Core components and design patterns used throughout the codebase
Coding Standards: TypeScript configuration, code style (Prettier/ESLint), naming conventions, and TypeScript patterns
Testing: Test structure with emphasis on preferring functional tests, writing guidelines, standard template, and running instructions
Database-Specific Considerations: Multi-database support and driver implementation details
Common Development Tasks: Adding features, decorators, and working with migrations
Build & Development Workflow: Commands, setup instructions, and pre-commit hooks
Contribution Guidelines: Commit message format and PR requirements
Common Patterns & Idioms: Code examples for entities, repositories, query builders, and transactions
Important Notes: Key considerations for developers
Resources: Links to documentation and guides

The instructions are based on the repository's existing documentation (CONTRIBUTING.md, DEVELOPER.md), configuration files (package.json, tsconfig.json, eslint.config.mjs, .prettierrc.json), and observed code patterns.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository

</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes ✨Set up Copilot instructions #11593

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

PR Type

Documentation

Description

Add comprehensive GitHub Copilot instructions for TypeORM repository
Document architecture, core components, and design patterns
Codify coding standards, TypeScript configuration, and naming conventions
Provide testing guidelines with multi-database test patterns
Include development workflow, build commands, and contribution guidelines

Diagram Walkthrough

flowchart LR
  A["GitHub Copilot"] -- "reads instructions from" --> B[".github/copilot-instructions.md"]
  B -- "documents" --> C["Architecture & Components"]
  B -- "documents" --> D["Coding Standards"]
  B -- "documents" --> E["Testing Guidelines"]
  B -- "documents" --> F["Development Workflow"]
  B -- "documents" --> G["Contribution Guidelines"]
  C --> H["DataSource, EntityManager, Repository, QueryBuilder"]
  D --> I["TypeScript, Prettier, ESLint, Naming Conventions"]
  E --> J["Multi-database Tests, Test Templates"]
  F --> K["Build Commands, Pre-commit Hooks"]
  G --> L["Commit Format, PR Requirements"]

File Walkthrough

Relevant files

Documentation

copilot-instructions.md `Comprehensive GitHub Copilot instructions for TypeORM` .github/copilot-instructions.md Created comprehensive Copilot instructions document for TypeORM repository Documented project overview, architecture, and core components (DataSource, EntityManager, Repository, QueryBuilder, decorators, drivers) Specified coding standards including TypeScript configuration, Prettier/ESLint rules, and naming conventions Provided testing guidelines with standard test template and multi-database test patterns Included database-specific considerations and driver implementation details Documented build commands, development workflow, and pre-commit hooks Added contribution guidelines with commit message format and PR requirements Included common patterns for entity definitions, repository usage, QueryBuilder, and transactions	+283/-0

coderabbitai · 2025-11-19T19:52:39Z

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

Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>

cloudflare-workers-and-pages · 2025-11-19T19:55:42Z

Deploying typeorm with Cloudflare Pages

Latest commit:	`125ca62`
Status:	⚡️ Build in progress...

View logs

qodo-free-for-open-source-projects · 2025-11-19T20:17:02Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance

🟢

No security concerns identified

No security vulnerabilities detected by AI analysis. Human verification advised for critical code.

Ticket Compliance

🟢

🎫 #11593

🟢	Configure instructions for the repository following GitHub's best practices for Copilot coding agent
	Set up repository-specific instructions to help Copilot provide context-aware assistance

Codebase Duplication Compliance

⚪

Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance

🟢

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

qodo-free-for-open-source-projects · 2025-11-19T20:18:09Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
High-level	Address long-term maintenance of Copilot instructions The new `copilot-instructions.md` file duplicates existing project information, creating a maintenance risk of it becoming outdated. A process should be established to keep it synchronized with the codebase. Examples: .github/copilot-instructions.md [41-46] ### Code Style - Formatting: Use Prettier with these settings: - No semicolons (`"semi": false`) - Arrow function parentheses always (`"arrowParens": "always"`) - Trailing commas everywhere (`"trailingComma": "all"`) .github/copilot-instructions.md [169-177] ### Commands - Build: `npm run compile` - Compiles TypeScript to `build/compiled/` - Package: `npm run package` - Creates distribution in `build/package/` - Pack: `npm run pack` - Creates `.tgz` file in `build/` - Test: `npm test` - Compile and run all tests - Lint: `npm run lint` - Run ESLint - Format: `npm run format` - Run Prettier - Watch: `npm run watch` - Watch mode for TypeScript compilation Solution Walkthrough: Before: // .github/copilot-instructions.md ## Code Style - Formatting: Use Prettier with these settings: - No semicolons (`"semi": false`) - ... ## Build & Development Workflow - Build: `npm run compile` - Test: `npm test` - ... ## Contribution Guidelines - Follow conventional commits - ... After: // Suggestion: Automate parts of the instructions file // and add a CI check to ensure it's up-to-date. // .github/copilot-instructions.md (partially auto-generated) ## Code Style <!-- AUTO-GENERATED-FROM: .prettierrc, .eslintrc --> - Formatting: Use Prettier with these settings: - No semicolons (`"semi": false`) <!-- END-AUTO-GENERATED --> // .github/workflows/ci.yml jobs: verify_copilot_instructions: name: Verify Copilot Instructions runs-on: ubuntu-latest steps: - run: npm run generate-copilot-instructions - run: git diff --exit-code .github/copilot-instructions.md Suggestion importance[1-10]: 8 __ Why: The suggestion correctly identifies a significant long-term maintenance risk, as the new `copilot-instructions.md` file duplicates information from other sources and could become outdated, leading to incorrect AI-generated code.	Medium
General	Clarify entity pattern usage guidance Clarify the instructions for entity instances to correctly represent both the Data Mapper and Active Record patterns supported by TypeORM, instead of only mentioning the Data Mapper pattern. .github/copilot-instructions.md [275] -- Entity instances should be plain objects, not class instances with methods (Data Mapper pattern) +- When using the Data Mapper pattern, entity classes should primarily contain properties and relations. Business logic should be in services, and persistence logic in repositories. +- For the Active Record pattern, entities extend `BaseEntity` and can have persistence methods like `save()` and `remove()`. Choose this pattern for simpler cases where logic is tightly coupled to the entity. Apply / Chat Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a misleading instruction that contradicts other parts of the document regarding supported design patterns, and the proposed change provides necessary clarification.	Medium
General	Reduce commit subject line length limit Reduce the maximum character limit for commit subject lines from 100 to 72 to align with conventional commit standards and improve readability. .github/copilot-instructions.md [211] -- Max 100 characters per line +- Max 72 characters Apply / Chat Suggestion importance[1-10]: 4 __ Why: The suggestion proposes changing the commit subject line length from 100 to 72 characters, which aligns with common Git best practices and improves commit history readability.	Low
Update

.github/copilot-instructions.md

gioboa

That's great

naorpeled · 2025-11-21T20:15:41Z

@copilot mention that we prefer functional tests instead of per-issues tests and only keep the target in the Typescript configuration section

Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>

Copilot · 2025-11-21T20:19:24Z

@copilot mention that we prefer functional tests instead of per-issues tests and only keep the target in the Typescript configuration section

Done in dd099e1. Simplified the TypeScript configuration section to only show the target and decorator settings, and added a note emphasizing preference for functional tests over per-issue tests.

naorpeled · 2025-11-21T20:42:00Z

@copilot please refrain from writing "use only when a functional test is not appropriate", instead only focus on the "prefer functional tests" part

Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>

Copilot · 2025-11-21T20:43:42Z

@copilot please refrain from writing "use only when a functional test is not appropriate", instead only focus on the "prefer functional tests" part

Done in 8056e04. Simplified the test guidance to only focus on preferring functional tests, removing the conditional language.

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Naor Peled <me@naor.dev>

Initial plan

e04d996

Copilot AI assigned Copilot and naorpeled Nov 19, 2025

Copilot started work on behalf of naorpeled November 19, 2025 19:52 View session

docs: add GitHub Copilot instructions for repository

58346ed

Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Set up Copilot instructions for the repository~~ Add GitHub Copilot instructions for TypeORM repository Nov 19, 2025

Copilot AI requested a review from naorpeled November 19, 2025 19:59

Copilot finished work on behalf of naorpeled November 19, 2025 19:59

naorpeled requested review from alumni, dlhck, gioboa and mguida22 November 19, 2025 20:16

naorpeled marked this pull request as ready for review November 19, 2025 20:16

qodo-free-for-open-source-projects bot added the Review effort 2/5 label Nov 19, 2025

naorpeled approved these changes Nov 19, 2025

View reviewed changes

alumni reviewed Nov 19, 2025

View reviewed changes

.github/copilot-instructions.md Show resolved Hide resolved

alumni reviewed Nov 19, 2025

View reviewed changes

.github/copilot-instructions.md Outdated Show resolved Hide resolved

alumni approved these changes Nov 19, 2025

View reviewed changes

gioboa approved these changes Nov 19, 2025

View reviewed changes

Copilot started work on behalf of naorpeled November 21, 2025 20:17 View session

docs: address PR feedback on Copilot instructions

dd099e1

Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>

Copilot AI requested a review from naorpeled November 21, 2025 20:20

Copilot finished work on behalf of naorpeled November 21, 2025 20:20

Copilot started work on behalf of naorpeled November 21, 2025 20:42 View session

docs: simplify test preference guidance in Copilot instructions

8056e04

Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>

Copilot finished work on behalf of naorpeled November 21, 2025 20:44

naorpeled changed the title ~~Add GitHub Copilot instructions for TypeORM repository~~ chore: add GitHub Copilot instructions Nov 21, 2025

Merge branch 'master' into copilot/setup-copilot-instructions

125ca62

naorpeled merged commit 5fa8a0b into master Nov 21, 2025
9 of 10 checks passed

naorpeled deleted the copilot/setup-copilot-instructions branch November 21, 2025 21:03

ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025

chore: add GitHub Copilot instructions (typeorm#11781)

1c0e5f9

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Naor Peled <me@naor.dev>

Minishlink mentioned this pull request Jan 12, 2026

fix(postgres): handle timestamptz correctly #11916

Open

mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026

chore: add GitHub Copilot instructions (typeorm#11781)

2d4b8de

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Naor Peled <me@naor.dev>

Uh oh!

chore: add GitHub Copilot instructions #11781

chore: add GitHub Copilot instructions #11781

Uh oh!

Conversation

Copilot AI commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Coverage

Comments on the Issue (you are @copilot in this section)

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

coderabbitai bot commented Nov 19, 2025

Review skipped

Uh oh!

cloudflare-workers-and-pages bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying typeorm with Cloudflare Pages

Uh oh!

qodo-free-for-open-source-projects bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Compliance Guide 🔍

Uh oh!

qodo-free-for-open-source-projects bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Examples:

Solution Walkthrough:

Before:

After:

Uh oh!

Uh oh!

Uh oh!

gioboa left a comment

Choose a reason for hiding this comment

Uh oh!

naorpeled commented Nov 21, 2025

Uh oh!

Copilot AI commented Nov 21, 2025

Uh oh!

naorpeled commented Nov 21, 2025

Uh oh!

Copilot AI commented Nov 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Nov 19, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Nov 19, 2025 •

edited

Loading

qodo-free-for-open-source-projects bot commented Nov 19, 2025 •

edited

Loading

qodo-free-for-open-source-projects bot commented Nov 19, 2025 •

edited

Loading