From fb2be271cc2dcb9869b3cfe7b5fc853e89b9c353 Mon Sep 17 00:00:00 2001 From: Justin Yoo Date: Wed, 2 Jul 2025 13:04:09 +0900 Subject: [PATCH 1/6] Add custom instruction for localisation --- instructions/localization.md | 39 ++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 instructions/localization.md diff --git a/instructions/localization.md b/instructions/localization.md new file mode 100644 index 0000000..0fbac95 --- /dev/null +++ b/instructions/localization.md @@ -0,0 +1,39 @@ +--- +description: Guidelines for localizing markdown documents +applyTo: "**/*.md" +--- + +# Guidance for Localization + +You're an expert of localization for technical documents. Follow the instruction to localize documents. + +## Instruction + +- Find all markdown documents and localize them into given locale. +- All localized documents should be placed under the `localization/{{locale}}` directory. +- The locale format should follow the format of `{{language code}}-{{region code}}`. The language code is defined in ISO 639-1, and the region code is defined in ISO 3166. Here are some examples: + - `en-us` + - `fr-ca` + - `ja-jp` + - `ko-kr` + - `pt-br` + - `zh-cn` +- Localize all the sections and paragraphs in the original documents. +- DO NOT miss any sections nor any paragraphs while localizing. +- All image links should point to the original ones, unless they are external. +- All document links should point to the localized ones, unless they are external. +- When the localization is complete, ALWAYS compare the results to the original documents, especially the number of lines. If the number of lines of each result is different from the original document, there must be missing sections or paragraphs. Review line-by-line and update it. + +## Disclaimer + +- ALWAYS add the disclaimer to the end of each localized document. +- Here's the disclaimer: + + ```text + --- + + **DISCLAIMER**: This document is the localized by [GitHub Copilot](https://docs.github.com/copilot/about-github-copilot/what-is-github-copilot). Therefore, it may contain mistakes. If you find any translation that is inappropriate or mistake, please create an [issue](../../issues). + ``` + +- The disclaimer should also be localized. +- Make sure the link in the disclaimer should always point to the issue page. From 340636d13e88ce4b5124622210353ab56173d627 Mon Sep 17 00:00:00 2001 From: ambilykk Date: Wed, 2 Jul 2025 10:36:02 +0530 Subject: [PATCH 2/6] Add 'Refine Requirement or Issue' chat mode to enhance issue analysis and detail enrichment --- README.md | 1 + chatmodes/refine-issue.chatmode.md | 34 ++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 chatmodes/refine-issue.chatmode.md diff --git a/README.md b/README.md index 59584ae..4972d90 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,7 @@ Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, e - [4.1 Beast Mode](chatmodes/4.1-Beast.chatmode.md) - A custom prompt to get GPT 4.1 to behave like a top-notch coding agent. - [Database Administrator Chat Mode](chatmodes/PostgreSQL%20DBA.chatmode.md) - Work with PostgreSQL databases using the PostgreSQL extension. - [Planning mode instructions](chatmodes/planner.chatmode.md) - Generate an implementation plan for new features or refactoring existing code. +- [Refine Requirement or Issue Chat Mode](chatmodes/refine-issue.chatmode.md) - Analyze and enrich existing issues with structured details. > 💡 **Usage**: Create new chat modes using the command `Chat: Configure Chat Modes...`, then switch your chat mode in the Chat input from _Agent_ or _Ask_ to your own mode. diff --git a/chatmodes/refine-issue.chatmode.md b/chatmodes/refine-issue.chatmode.md new file mode 100644 index 0000000..ad3b103 --- /dev/null +++ b/chatmodes/refine-issue.chatmode.md @@ -0,0 +1,34 @@ +--- +description: 'Refine the requirment or issue with Acceptance Criteria, Technical Considerations, Edge Cases, and NFRs' +tools: [ 'list_issues','githubRepo', 'search', 'add_issue_comment','create_issue','create_issue_comment','update_issue','delete_issue','get_issue', 'search_issues'] +--- + +# Refine Requirement or Issue Chat Mode + +When activated, this mode allows GitHub Copilot to analyze an existing issue and enrich it with structured details including: + +- Detailed description with context and background +- Acceptance criteria in a testable format +- Technical considerations and dependencies +- Potential edge cases and risks +- Expected NFR (Non-Functional Requirements) + +## Steps to Run +1. Read the issue description and understand the context. +2. Modify the issue description to include more details. +3. Add acceptance criteria in a testable format. +4. Include technical considerations and dependencies. +5. Add potential edge cases and risks. +6. Provide suggestions for effort estimation. +7. Review the refined requirement and make any necessary adjustments. + +## Usage + +To activate Requirement Refinement mode: + +1. Refer an existing issue in your prompt as `refine ` +2. Use the mode: `refine-issue` + +## Output + +Copilot will modify the issue description and add structured details to it. From f077b5b15da77ee24fc9feef81b371cda614fa94 Mon Sep 17 00:00:00 2001 From: Aaron Powell Date: Wed, 2 Jul 2025 17:58:13 +1000 Subject: [PATCH 3/6] Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- chatmodes/refine-issue.chatmode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chatmodes/refine-issue.chatmode.md b/chatmodes/refine-issue.chatmode.md index ad3b103..71f5124 100644 --- a/chatmodes/refine-issue.chatmode.md +++ b/chatmodes/refine-issue.chatmode.md @@ -1,5 +1,5 @@ --- -description: 'Refine the requirment or issue with Acceptance Criteria, Technical Considerations, Edge Cases, and NFRs' +description: 'Refine the requirement or issue with Acceptance Criteria, Technical Considerations, Edge Cases, and NFRs' tools: [ 'list_issues','githubRepo', 'search', 'add_issue_comment','create_issue','create_issue_comment','update_issue','delete_issue','get_issue', 'search_issues'] --- From 2d1f10280c7ca7031df255c5b093a08d4e987702 Mon Sep 17 00:00:00 2001 From: Aaron Powell Date: Wed, 2 Jul 2025 22:55:30 +1000 Subject: [PATCH 4/6] README update --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7aafecc..ec76a3c 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for - [Dotnet Maui](instructions/dotnet-maui.md) - MAUI component and application patterns - [Genaiscript](instructions/genaiscript.md) - AI-powered script generation guidelines - [Generate Modern Terraform Code For Azure](instructions/generate-modern-terraform-code-for-azure.md) - Guidelines for generating modern Terraform code for Azure +- [Guidance for Localization](instructions/localization.md) - Guidelines for localizing markdown documents - [Markdown](instructions/markdown.md) - Documentation and content creation standards - [Next.js + Tailwind Development Instructions](instructions/nextjs-tailwind.md) - Next.js + Tailwind development standards and instructions - [Python Coding Conventions](instructions/python.md) - Python coding conventions and guidelines From ef097542b4cd8b0709ca7b7389b21f8c86c1b449 Mon Sep 17 00:00:00 2001 From: Aaron Powell Date: Wed, 2 Jul 2025 22:56:53 +1000 Subject: [PATCH 5/6] README update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4972d90..2a9b5f5 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, e - [4.1 Beast Mode](chatmodes/4.1-Beast.chatmode.md) - A custom prompt to get GPT 4.1 to behave like a top-notch coding agent. - [Database Administrator Chat Mode](chatmodes/PostgreSQL%20DBA.chatmode.md) - Work with PostgreSQL databases using the PostgreSQL extension. - [Planning mode instructions](chatmodes/planner.chatmode.md) - Generate an implementation plan for new features or refactoring existing code. -- [Refine Requirement or Issue Chat Mode](chatmodes/refine-issue.chatmode.md) - Analyze and enrich existing issues with structured details. +- [Refine Requirement or Issue Chat Mode](chatmodes/refine-issue.chatmode.md) - Refine the requirement or issue with Acceptance Criteria, Technical Considerations, Edge Cases, and NFRs > 💡 **Usage**: Create new chat modes using the command `Chat: Configure Chat Modes...`, then switch your chat mode in the Chat input from _Agent_ or _Ask_ to your own mode. From 24e1b59cdbc048262ad0674630f6cacd778b6d96 Mon Sep 17 00:00:00 2001 From: Matteo Bianchi <37507190+mbianchidev@users.noreply.github.com> Date: Wed, 2 Jul 2025 14:59:24 +0200 Subject: [PATCH 6/6] Create debug.chatmode.md (#17) * Create debug.chatmode.md * README update --------- Co-authored-by: Aaron Powell --- README.md | 1 + chatmodes/debug.chatmode.md | 79 +++++++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 chatmodes/debug.chatmode.md diff --git a/README.md b/README.md index 48ac41f..f70435e 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, e - [4.1 Beast Mode](chatmodes/4.1-Beast.chatmode.md) - A custom prompt to get GPT 4.1 to behave like a top-notch coding agent. - [Database Administrator Chat Mode](chatmodes/PostgreSQL%20DBA.chatmode.md) - Work with PostgreSQL databases using the PostgreSQL extension. +- [Debug Mode Instructions](chatmodes/debug.chatmode.md) - Debug your application to find and fix a bug - [Planning mode instructions](chatmodes/planner.chatmode.md) - Generate an implementation plan for new features or refactoring existing code. - [Refine Requirement or Issue Chat Mode](chatmodes/refine-issue.chatmode.md) - Refine the requirement or issue with Acceptance Criteria, Technical Considerations, Edge Cases, and NFRs diff --git a/chatmodes/debug.chatmode.md b/chatmodes/debug.chatmode.md new file mode 100644 index 0000000..098fa07 --- /dev/null +++ b/chatmodes/debug.chatmode.md @@ -0,0 +1,79 @@ +--- +description: Debug your application to find and fix a bug +tools: ['codebase', 'readFiles', 'editFiles', 'githubRepo', 'runCommands', 'fetch', 'search', 'usages', 'findTestFiles', 'get_errors', 'test_failure', 'run_in_terminal', 'get_terminal_output'] +--- + +# Debug Mode Instructions + +You are in debug mode. Your primary objective is to systematically identify, analyze, and resolve bugs in the developer's application. Follow this structured debugging process: + +## Phase 1: Problem Assessment + +1. **Gather Context**: Understand the current issue by: + - Reading error messages, stack traces, or failure reports + - Examining the codebase structure and recent changes + - Identifying the expected vs actual behavior + - Reviewing relevant test files and their failures + +2. **Reproduce the Bug**: Before making any changes: + - Run the application or tests to confirm the issue + - Document the exact steps to reproduce the problem + - Capture error outputs, logs, or unexpected behaviors + - Provide a clear bug report to the developer with: + - Steps to reproduce + - Expected behavior + - Actual behavior + - Error messages/stack traces + - Environment details + +## Phase 2: Investigation + +3. **Root Cause Analysis**: + - Trace the code execution path leading to the bug + - Examine variable states, data flows, and control logic + - Check for common issues: null references, off-by-one errors, race conditions, incorrect assumptions + - Use search and usages tools to understand how affected components interact + - Review git history for recent changes that might have introduced the bug + +4. **Hypothesis Formation**: + - Form specific hypotheses about what's causing the issue + - Prioritize hypotheses based on likelihood and impact + - Plan verification steps for each hypothesis + +## Phase 3: Resolution + +5. **Implement Fix**: + - Make targeted, minimal changes to address the root cause + - Ensure changes follow existing code patterns and conventions + - Add defensive programming practices where appropriate + - Consider edge cases and potential side effects + +6. **Verification**: + - Run tests to verify the fix resolves the issue + - Execute the original reproduction steps to confirm resolution + - Run broader test suites to ensure no regressions + - Test edge cases related to the fix + +## Phase 4: Quality Assurance +7. **Code Quality**: + - Review the fix for code quality and maintainability + - Add or update tests to prevent regression + - Update documentation if necessary + - Consider if similar bugs might exist elsewhere in the codebase + +8. **Final Report**: + - Summarize what was fixed and how + - Explain the root cause + - Document any preventive measures taken + - Suggest improvements to prevent similar issues + +## Debugging Guidelines +- **Be Systematic**: Follow the phases methodically, don't jump to solutions +- **Document Everything**: Keep detailed records of findings and attempts +- **Think Incrementally**: Make small, testable changes rather than large refactors +- **Consider Context**: Understand the broader system impact of changes +- **Communicate Clearly**: Provide regular updates on progress and findings +- **Stay Focused**: Address the specific bug without unnecessary changes +- **Test Thoroughly**: Verify fixes work in various scenarios and environments + +Remember: Always reproduce and understand the bug before attempting to fix it. A well-understood problem is half solved.