Skip to content

Add GitHub Copilot instructions for project conventions and release process#498

Merged
nev21 merged 5 commits into
mainfrom
copilot/add-copilot-instructions
May 11, 2026
Merged

Add GitHub Copilot instructions for project conventions and release process#498
nev21 merged 5 commits into
mainfrom
copilot/add-copilot-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 11, 2026

Adds .github/copilot-instructions.md to give Copilot context about this repo's conventions, with particular focus on the release process which has specific requirements that aren't obvious from code alone.

What's documented

  • Project overview — library purpose, Promise implementation types, minification focus
  • Repo structure — monorepo layout (root vs lib/), what gets published to npm
  • Build/lint/test commandsnpm run lint, npm run build, npm test
  • Release process — the critical rules Copilot must follow:
    • Commit message format: [Release] Increase version to x.y.z
    • Files requiring updates: both package.json files, README.md (recommended version range), CHANGELIST.md
    • CHANGELIST.md rules: preserve unreleased items verbatim, move them under a new versioned heading, append a GitHub compare link (v{prev}...v{new}), leave an empty # Unreleased section for future changes
  • Coding conventions — ES5 compat target, minification-oriented design, test environments (Node 18/20/22/24, Chromium browser + worker)

Copilot AI linked an issue May 11, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add copilot onboarding instructions and release updates Add GitHub Copilot instructions for project conventions and release process May 11, 2026
Copilot finished work on behalf of nev21 May 11, 2026 05:13
Copilot AI requested a review from nev21 May 11, 2026 05:13
@nev21 nev21 marked this pull request as ready for review May 11, 2026 05:51
@nev21 nev21 requested a review from a team as a code owner May 11, 2026 05:51
Copilot AI review requested due to automatic review settings May 11, 2026 05:51
@nev21 nev21 requested a review from a team as a code owner May 11, 2026 05:51
@nev21 nev21 enabled auto-merge (squash) May 11, 2026 05:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a repository-specific Copilot instruction document to capture project conventions and the release process requirements that aren’t easily inferred from the codebase.

Changes:

  • Introduces .github/copilot-instructions.md describing the library purpose, monorepo layout, and key build/lint/test commands.
  • Documents the expected release workflow, including files to update and CHANGELIST.md formatting rules.
  • Summarizes coding/testing conventions (ES5 compatibility, minification-oriented exports, CI test environments).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
nev21 and others added 3 commits May 10, 2026 22:54
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@nev21 nev21 requested a review from Copilot May 11, 2026 05:55
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment on lines +40 to +43
Full rebuild (clean build + tests + size checks):
```bash
npm run rebuild
```

## Changelog

# v{new-version} {Month} {Day}, {Year}
@codecov
Copy link
Copy Markdown

codecov Bot commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.56%. Comparing base (a7c57ba) to head (25ef0cb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #498   +/-   ##
=======================================
  Coverage   97.56%   97.56%           
=======================================
  Files          27       27           
  Lines        1439     1439           
  Branches      337      339    +2     
=======================================
  Hits         1404     1404           
  Misses         35       35           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@nevware21-bot nevware21-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved by nevware21-bot

@nev21 nev21 merged commit 1678613 into main May 11, 2026
14 checks passed
@nev21 nev21 deleted the copilot/add-copilot-instructions branch May 11, 2026 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] Onboard to copilot introducing instructions

4 participants