Add repository skills for common development workflows#1061
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds new Copilot “skill” documents under .github/skills/ to standardize common development workflows in the Menu repository (testing, endpoint creation, EF migrations, frontend conventions, OpenAPI sync, and review checklists).
Changes:
- Adds a new
write-testsskill documenting unit/integration test patterns and infrastructure requirements. - Adds new skills covering API endpoint layering, Vogen value objects, EF migrations, frontend component conventions, OpenAPI regeneration, PR comment attribution, and a PR review checklist.
- Introduces repository-specific “rules” in checklist/skills intended to guide consistent implementation and review.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/skills/write-tests/SKILL.md | Documents unit/integration test patterns and prerequisites (but contains several repo-mismatches). |
| .github/skills/pr-comment-identity/SKILL.md | Defines a required attribution block for Copilot-authored PR review thread comments. |
| .github/skills/openapi-sync/SKILL.md | Describes backend→OpenAPI→frontend type generation workflow (but includes an un-followable “commit the JSON” step). |
| .github/skills/frontend-component/SKILL.md | Documents Vue/Quasar component conventions and API/service-layer usage (but folder layout + example usage don’t match repo). |
| .github/skills/ef-migration/SKILL.md | Documents EF Core migration commands and runtime migration behavior in this repo’s layout. |
| .github/skills/code-review-checklist/SKILL.md | Adds a structured PR review checklist (but contains requirements that don’t match current repo behavior). |
| .github/skills/add-value-object/SKILL.md | Documents how to add Vogen value objects (but references an incorrect VogenDefaults file path). |
| .github/skills/add-api-endpoint/SKILL.md | Documents the minimal API endpoint “layered” pattern (but includes conventions that diverge from current implementation). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add 8 new skills covering the most frequent development tasks in this repository: - pr-comment-identity: all Copilot PR review comments must open with a clear attribution block so reviewers know the comment is automated - add-api-endpoint: step-by-step guide for the full 7-step endpoint pattern (ViewModel → DBModel → Mapperly → repo → service → MapGroup → DI) - ef-migration: canonical EF CLI commands with correct --project / --startup-project flags and safety rules around runtime migration application via Menu.MigrationService - add-value-object: Vogen value object creation, VogenDefaults.cs assembly-level defaults, and repository wrap/unwrap conventions - frontend-component: Vue 3 + Quasar component folder placement, Composition API style, co-located Storybook stories, and the two-layer API service pattern - openapi-sync: post-endpoint-change type regeneration workflow to keep menu-api.ts in sync with the backend spec - write-tests: unit test (CustomAutoData, FakeItEasy, AwesomeAssertions) and integration test (ShortStringAutoData, API Host Collection) patterns - code-review-checklist: structured PR review checklist covering layer separation, Vogen coverage, Mapperly, async, DI, StyleCop, tests, and frontend conventions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- openapi-sync: clarify open-api/*.json is gitignored; only commit generated TS types - add-api-endpoint: use .Produces<T>() convention (not .WithName/.WithOpenApi); ViewModel DTOs are classes not records - add-value-object: fix VogenDefaults.cs path to backend/MenuApi/VogenDefaults.cs - write-tests: replace ShortStringAutoData with [Theory,AutoData]+[StringLength]/[NoAutoProperties] pattern; add parameters__Auth0Audience to secrets list; remove ConfigureAwait from test method example - frontend-component: fix component folder table to atomic design structure (atoms/molecules/organisms/templates); fix service usage to use useRecipeService() factory composable - code-review-checklist: update endpoint docs convention; fix openapi JSON gitignore note; fix integration test attribute guidance Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dgee2
force-pushed
the
dgee2/skills-summary
branch
from
f424700 to
f772642
Compare
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds 8 new Copilot skills to
.github/skills/covering the most frequent development tasks in this repository.Skills added
pr-comment-identity> 🤖 **This comment was written by GitHub Copilot.**attribution blockadd-api-endpointef-migration--project MenuDB --startup-project MenuApiflags, safety rules arounddotnet ef database update, and howMenu.MigrationServiceapplies migrations at runtimeadd-value-objectVogenDefaults.csenables EF and Swagger registration automatically, and repository wrap/unwrap conventionsfrontend-componentopenapi-syncmenu-api.tsfrom the .NET build output — never hand-write types insrc/generated/write-tests[CustomAutoData], FakeItEasy, AwesomeAssertions) and integration test patterns ([ShortStringAutoData],[Collection("API Host Collection")])code-review-checklistType of change
Documentation / tooling — no source code changes.