Skip to content

chore(copilot): scaffold repo instructions#354

Merged
wax911 merged 3 commits into
developfrom
copilot/fix-40f4fcf8-f670-429c-9e2d-077fc1c88b62
Aug 28, 2025
Merged

chore(copilot): scaffold repo instructions#354
wax911 merged 3 commits into
developfrom
copilot/fix-40f4fcf8-f670-429c-9e2d-077fc1c88b62

Conversation

Copilot AI commented Aug 24, 2025

Copy link
Copy Markdown
Contributor

This PR scaffolds GitHub Copilot customization assets for the support-query-builder repository by copying baseline configurations from AniTrend/anitrend-v2 and creating repo-specific instructions.

Changes Made

Created Repo-Specific Instructions

Context Instructions (.github/instructions/context.instructions.md):

  • Describes the support-query-builder architecture and module structure
  • Explains the 4-module organization: core, core:ext, annotations, processor
  • Details the type-safe SQL query builder design principles
  • Documents Room integration patterns and annotation processing workflows
  • References the Dokka documentation site for comprehensive API details

Updated Documentation

CONTRIBUTING.md:

  • Added "GitHub Copilot customization" section explaining the new assets
  • Documented locations of chat modes, prompts, and instructions
  • Added guidance on using conventional commit prompts with generic scopes
  • Included link to the Dokka documentation site

This scaffolding provides a foundation for enhanced GitHub Copilot interactions while respecting the project's specific architecture and documentation patterns.

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:

  • dl.google.com
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-opens=java.base/java.nio.charset=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens=java.xml/javax.xml.namespace=ALL-UNNAMED -Xmx2048m -Dfile.encoding=UTF-8 -Duser.country -Duser.language=en -Duser.variant -cp /home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/gradle-daemon-main-9.0.0.jar -javaagent:/home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/agents/gradle-instrumentation-agent-9.0.0.jar org.gradle.launcher.daemon.bootstrap.GradleDaemon 9.0.0 (dns block)
  • www.jitpack.io
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-opens=java.base/java.nio.charset=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens=java.xml/javax.xml.namespace=ALL-UNNAMED -Xmx2048m -Dfile.encoding=UTF-8 -Duser.country -Duser.language=en -Duser.variant -cp /home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/gradle-daemon-main-9.0.0.jar -javaagent:/home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/agents/gradle-instrumentation-agent-9.0.0.jar org.gradle.launcher.daemon.bootstrap.GradleDaemon 9.0.0 (dns block)

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


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

Copilot AI changed the title [WIP] chore(copilot): scaffold chat modes, prompts, and repo instructions chore(copilot): scaffold chat modes, prompts, and repo instructions Aug 24, 2025
Copilot AI requested a review from wax911 August 24, 2025 22:02
@wax911 wax911 changed the title chore(copilot): scaffold chat modes, prompts, and repo instructions chore(copilot): scaffold repo instructions Aug 28, 2025
@wax911 wax911 marked this pull request as ready for review August 28, 2025 15:54
Copilot AI review requested due to automatic review settings August 28, 2025 15:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR scaffolds GitHub Copilot customization assets for the support-query-builder repository by implementing a comprehensive set of chat modes, prompts, and instructions to enhance the AI-assisted development experience.

  • Establishes foundational GitHub Copilot infrastructure with chat modes, prompts, and repository-specific context instructions
  • Creates extensive template system for specifications, implementation plans, and architectural decision records
  • Updates contributing documentation to guide developers on using the new Copilot customization features

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

File Description
CONTRIBUTING.md Added GitHub Copilot customization section documenting new assets and conventional commit usage
.github/instructions/context.instructions.md Created comprehensive project architecture documentation for AI context
.github/prompts/*.prompt.md Added 7 structured prompt templates for specifications, plans, workflows, and commit messages
.github/chatmodes/*.chatmode.md Implemented 6 specialized chat modes for different development scenarios

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

- Include examples and edge cases where applicable.
- Ensure the document is self-contained and does not rely on external context.

The specification should be saved in the [/spec/](/spec/) directory and named according to the following convention: `[a-z0-9-]+.md`, where the name should be descriptive of the specification's content and starting with the highlevel purpose, which is one of [schema, tool, data, infrastructure, process, architecture, or design].

Copilot AI Aug 28, 2025

Copy link

Choose a reason for hiding this comment

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

Fix spelling error: 'highlevel' should be 'high-level'

Suggested change
The specification should be saved in the [/spec/](/spec/) directory and named according to the following convention: `[a-z0-9-]+.md`, where the name should be descriptive of the specification's content and starting with the highlevel purpose, which is one of [schema, tool, data, infrastructure, process, architecture, or design].
The specification should be saved in the [/spec/](/spec/) directory and named according to the following convention: `[a-z0-9-]+.md`, where the name should be descriptive of the specification's content and starting with the high-level purpose, which is one of [schema, tool, data, infrastructure, process, architecture, or design].

Copilot uses AI. Check for mistakes.
---

# Introduction

Copilot AI Aug 28, 2025

Copy link

Choose a reason for hiding this comment

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

The badge URL uses placeholder syntax that won't render correctly. Consider using actual status values or providing clearer instructions on how to replace these placeholders.

Copilot uses AI. Check for mistakes.

## Issue Content

- Title: [module:sub_module] Brief description of what the requiment is (if no sumodule then `[module]` will suffice)

Copilot AI Aug 28, 2025

Copy link

Choose a reason for hiding this comment

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

Fix spelling errors: 'requiment' should be 'requirement' and 'sumodule' should be 'submodule'

Suggested change
- Title: [module:sub_module] Brief description of what the requiment is (if no sumodule then `[module]` will suffice)
- Title: [module:submodule] Brief description of what the requirement is (if no submodule then `[module]` will suffice)

Copilot uses AI. Check for mistakes.
- You MUST follow ALL Markdown best practices and conventions for this project
- You MUST update ALL Markdown links to sections if section names or locations change
- You WILL remove any invisible or hidden unicode characters
- You WILL AVOID overusing bolding (`*`) EXCEPT when needed for emphasis, e.g.: **CRITICAL**, You WILL ALWAYS follow these instructions

Copilot AI Aug 28, 2025

Copy link

Choose a reason for hiding this comment

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

The instruction references markdown bolding syntax incorrectly. Markdown uses **text** for bold, not *text* (which is italics).

Suggested change
- You WILL AVOID overusing bolding (`*`) EXCEPT when needed for emphasis, e.g.: **CRITICAL**, You WILL ALWAYS follow these instructions
- You WILL AVOID overusing bolding (`**`) EXCEPT when needed for emphasis, e.g.: **CRITICAL**, You WILL ALWAYS follow these instructions

Copilot uses AI. Check for mistakes.
Comment thread .github/instructions/context.instructions.md Outdated
Co-authored-by: wax911 <7859175+wax911@users.noreply.github.com>
@wax911 wax911 force-pushed the copilot/fix-40f4fcf8-f670-429c-9e2d-077fc1c88b62 branch from 5415aeb to 4c97574 Compare August 28, 2025 16:29
@github-actions github-actions Bot added the docs label Aug 28, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@wax911 wax911 merged commit dd7f646 into develop Aug 28, 2025
8 of 9 checks passed
@wax911 wax911 deleted the copilot/fix-40f4fcf8-f670-429c-9e2d-077fc1c88b62 branch August 28, 2025 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants