Adding copilot instructions #7563
Open
+1,875
−4
Conversation
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
…examples - Created tech-stack.md documenting TypeScript, React, Vite, and dependencies - Created analyzer-patterns.md with analyzer structure and design patterns - Created event-listeners.md with event listener signatures and patterns - Created normalizers.md for event linking and ordering patterns - Created verification.md emphasizing verification before assuming code exists - Updated main copilot-instructions.md to reference all new documentation - Used Enhancement and Elemental shaman as primary clean code examples - Included code examples over explanations throughout - Emphasized verifying spells, talents, and modules before using them Co-authored-by: Seriousnes <6109344+Seriousnes@users.noreply.github.com>
Add comprehensive Copilot instructions documenting tech stack and implementation patterns
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive Copilot instructions for coding agents working with the WoWAnalyzer codebase. The documentation covers the tech stack, design patterns, and best practices for developing combat log analyzers.
Key Changes
- Created a main copilot instructions file that serves as an entry point and quick reference guide
- Added detailed documentation for core concepts: analyzers, event listeners, normalizers, and verification
- Included extensive code examples and common patterns for TypeScript/React development
- Updated build instructions to clarify when to run tests
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/copilot-instructions.md | Main entry point providing overview, quick start guide, and links to detailed documentation |
| .github/instructions/verification.md | Guidelines for verifying code, avoiding assumptions, and common mistakes to prevent |
| .github/instructions/tech-stack.md | Comprehensive tech stack documentation including versions, dependencies, and project structure |
| .github/instructions/normalizers.md | Detailed guide on event normalizers, event linking, and event ordering |
| .github/instructions/event-listeners.md | Complete reference for event-driven architecture and listener patterns |
| .github/instructions/analyzer-patterns.md | Patterns and best practices for creating analyzer modules |
| .github/instructions/follow-up-questions.instructions.md | Instructions requiring 97% confidence before making changes |
| .github/instructions/build.instructions.md | Updated to clarify when tests should be run |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
91d3c25 to
9c87e23
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Adding comprehensive copilot instructions for use with coding agents