Skip to content

[Docs] Add Copilot instructions and pr-finalize skill#1579

Open
badrishc wants to merge 10 commits intodevfrom
badrishc/add-copilot-instructions
Open

[Docs] Add Copilot instructions and pr-finalize skill#1579
badrishc wants to merge 10 commits intodevfrom
badrishc/add-copilot-instructions

Conversation

@badrishc
Copy link
Collaborator

@badrishc badrishc commented Feb 26, 2026 •
edited
Loading

Adds Copilot instructions and a PR finalization skill to help AI assistants work effectively in this repository.

What's included

Copilot instructions (.github/copilot-instructions.md)

  • Build/test/lint commands - including single-test execution and Tsavorite-specific commands
  • Architecture - unified single-store design with three context types (string, object, unified), ValueIsObject record discrimination
  • Adding new RESP commands - 10-step guide with exact file paths for parsing, dispatch, storage, and testing
  • Custom extensions - four extensibility points with example paths and server.Register API
  • Test conventions - Allure/NUnit requirements, server lifecycle, common CreateGarnetServer parameters
  • Key conventions - file headers, coding style, performance patterns, configuration settings, PR protocol with component prefix convention

PR finalize skill (.github/skills/pr-finalize/)

  • Copilot skill for reviewing PR title, description, and code before merge
  • Adapted from dotnet/maui with Garnet-specific conventions (epoch management, RESP correctness, performance/allocation review, Allure test wiring)
  • Includes a complete example showing an agent-optimized PR description for a ZADD change

Notes

  • All file paths verified against the dev branch codebase
  • Includes a callout that website docs may reference the older two-store architecture
  • PR finalize skill is analysis-only — never approves, requests changes, or posts comments directly

@badrishc
Add .github/copilot-instructions.md for Copilot context
29bd6b5 
Adds a comprehensive Copilot instructions file covering:
- Build, test, and lint commands (including single-test execution)
- Unified single-store architecture with three context types
- Step-by-step guide for adding new RESP commands
- Custom extensions registration patterns
- Test structure with Allure/NUnit requirements
- Configuration, coding style, and performance conventions

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 26, 2026 23:46
Copilot AI reviewed Feb 26, 2026
View reviewed changes
Copy link
Contributor

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 instructions document intended to help AI assistants contribute effectively to Garnet by summarizing build/test commands, core architecture, command implementation workflow, extension points, and key coding/testing conventions.

Changes:

  • Introduces .github/copilot-instructions.md with verified build/test/format commands and repo navigation pointers.
  • Documents the unified single-store architecture (string/object/unified contexts; ValueIsObject record discrimination).
  • Provides a step-by-step guide for adding RESP commands and registering custom extensions.

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

@badrishc
Address PR review comments on copilot-instructions.md
6e11cc1 
- Change XML doc comments from 'required' to 'strongly recommended' with
  note about .editorconfig suggestion-level severity
- Fix duplicated 'Common optional parameters' sentence and double-period typo
  in server lifecycle bullet
- Fix SaveKeyEntryToLock signature: remove non-existent isObject parameter,
  document PinnedSpanByte key type

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@badrishc badrishc requested a review from Copilot February 27, 2026 00:07
Copilot AI reviewed Feb 27, 2026
View reviewed changes
Copy link
Contributor

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.

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

@badrishc badrishc changed the title Add .github/copilot-instructions.md [Docs] Add Copilot instructions and pr-finalize skill Feb 27, 2026
@badrishc badrishc requested a review from Copilot February 27, 2026 17:30
Copilot AI reviewed Feb 27, 2026
View reviewed changes
Copy link
Contributor

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 3 out of 3 changed files in this pull request and generated 1 comment.

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

badrishc and others added 2 commits February 27, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@badrishc