Skip to content

Configure Copilot instructions with repository-specific guidelines - #26

Merged
miccy merged 3 commits into
mainfrom
copilot/set-up-copilot-instructions
Feb 5, 2026
Merged

Configure Copilot instructions with repository-specific guidelines#26
miccy merged 3 commits into
mainfrom
copilot/set-up-copilot-instructions

Conversation

Copilot AI commented Feb 5, 2026

Copy link
Copy Markdown

GitHub Copilot needs explicit context about this fork's tooling and patterns to generate appropriate suggestions.

Changes to .github/copilot-instructions.md

Added Repository Context

  • Project overview: Local-first platform fork using Bun 1.3.8 + Biome 2.3.13
  • Tech stack declaration: Vitest, Turbo, Node.js >=24.0.0
  • Directory structure: Package/app breakdown

Repository-Specific Requirements

  • Package management: Enforce Bun commands (MUST NOT use npm/pnpm/yarn)
  • Linting/formatting: Enforce Biome (MUST NOT add ESLint/Prettier configs)
  • Testing: Vitest patterns with testCreateDeps() isolation
  • Security: 6 explicit requirements (no secrets, validate inputs with Type system, Result<T,E> error handling, trySync/tryAsync wrappers)
  • Upstream sync: Fork workflow and issue referencing (upstream#XXX)

Quick References

  • Workflow commands: Development, quality checks, release
  • Deprecated patterns: 9 anti-patterns (default exports, namespace imports, function keyword, class components, any type, global instances, pnpm/npm/yarn, ESLint/Prettier, throwing errors)
  • Code checklists: TDD, DI, Result patterns, immutability

Corrections

  • Fixed 3 pnpm references → bun
  • Updated ESLint error section → Biome/TypeScript

Impact

Copilot will now suggest Bun commands, Biome patterns, functional error handling, and TDD approaches aligned with repository conventions.

File grew from 528 → 649 lines (+121 lines of guidance).

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:

  • gh.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

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

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>

<agent_instructions>Best practise, efektivní a hlavně bezpečné Copilot instruction.</agent_instructions>

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


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

Summary by CodeRabbit

  • Documentation
    • Enhanced development guidelines with expanded project overview, including tech stack and directory structure
    • Introduced comprehensive repository guidelines across packages, testing, and security practices
    • Added workflow command reference section with development, quality checks, and release commands
    • Refined code style guidance with updated examples and TypeScript language practices

…fic guidelines

Co-authored-by: miccy <9729864+miccy@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up Copilot instructions for the repository Configure Copilot instructions with repository-specific guidelines Feb 5, 2026
Copilot AI requested a review from miccy February 5, 2026 03:59
@miccy
miccy marked this pull request as ready for review February 5, 2026 04:05
@coderabbitai

coderabbitai Bot commented Feb 5, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This change creates and expands the Copilot instructions documentation file for the repository, establishing comprehensive guidelines covering project overview, tech stack, directory structure, repository conventions, workflow commands, testing, security, and coding style patterns.

Changes

Cohort / File(s) Summary
Copilot Instructions
.github/copilot-instructions.md
Replaces header and project description with "Evolu Plan B - Copilot Instructions." Expands with project overview, tech stack details, directory structure, and multi-section guidelines. Introduces new Workflow Commands section. Updates monorepo TypeScript issues documentation. Extends style guidance (JSDoc, dependency injection, Result patterns). Replaces pnpm references with Bun commands throughout.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hop, hop, the instructions now grow,
Where Copilot's wisdom shall brightly flow,
With guidelines and patterns all neatly laid,
This repository's path has been beautifully made!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: configuring Copilot instructions with repository-specific guidelines, which is the primary focus of the changeset.
Linked Issues check ✅ Passed The PR fully implements the requirement from issue #25 to set up Copilot instructions with repository-specific guidelines, establishing comprehensive coding standards and best practices.
Out of Scope Changes check ✅ Passed All changes are directly scoped to configuring the .github/copilot-instructions.md file with repository guidelines as required by issue #25; no out-of-scope changes detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/set-up-copilot-instructions

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In @.github/copilot-instructions.md:
- Around line 25-37: The fenced code block showing the repository directory
structure lacks a language identifier; update the opening triple-backtick for
that block to include a language specifier (e.g., change the fence that
currently is ``` to ```text) so the block in .github/copilot-instructions.md
renders/accessibility properly—locate the directory tree block (the
triple-backtick before the "packages/" listing) and add the language token.
- Line 559: Update the wording that attributes "Unsafe call", "Unsafe member
access", and "Unsafe assignment" errors to Biome: change the text to state these
messages are emitted by the TypeScript language server (TypeScript type
checking) rather than Biome, and adjust the suggested solution wording to say
"reload the TypeScript language server / VS Code window" (e.g., reference the VS
Code command "Developer: Reload Window") so it accurately reflects that the
errors originate from TypeScript rather than the Biome linter.

Comment thread .github/copilot-instructions.md
Comment thread .github/copilot-instructions.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>
@miccy
miccy merged commit e9f7a58 into main Feb 5, 2026
5 checks passed
@miccy
miccy deleted the copilot/set-up-copilot-instructions branch February 10, 2026 01:25
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.

✨ Set up Copilot instructions

2 participants