Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 1, 2025

Enhances .github/copilot-instructions.md with additional context needed for effective Copilot coding agent usage per best practices.

Added sections

  • Build, Lint, and Format Commands — All bun commands for dev workflow
  • Data Fetching PatternsjsonFetcher usage and SWR hook creation
  • Coding Conventions — TypeScript, .d.ts patterns, exports, path aliases
  • Libraries — Added zod and react-hook-form to existing list

Example patterns documented

// API function pattern
import { jsonFetcher } from '@/app/_lib/fetcher';

export async function getResource() {
  return jsonFetcher('/1.0/resource').then(
    (data) => data.metadata as ResourceType,
  );
}

// SWR hook pattern
export function useResource() {
  return useSWR('/1.0/resource', getResource);
}

Existing setup (copilot-setup-steps.yml, code-reviewer.md, dependabot.yml) was already in good shape.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 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 self-assigned this Dec 1, 2025
…tterns, and coding conventions

Co-authored-by: Hye-Dev <[email protected]>
Copilot AI changed the title [WIP] Set up Copilot instructions for the repository ✨ Set up Copilot instructions Dec 1, 2025
Copilot AI requested a review from Hye-Dev December 1, 2025 22:12
@Hye-Dev
Copy link
Member

Hye-Dev commented Dec 1, 2025

@copilot Please review https://gh.io/copilot-coding-agent-tips and make changes accordingly

Copy link
Contributor Author

Copilot AI commented Dec 1, 2025

@copilot Please review https://gh.io/copilot-coding-agent-tips and make changes accordingly

I'm unable to access the URL directly due to network restrictions in this environment. However, based on the best practices I'm familiar with, the copilot-instructions.md file now includes all recommended sections:

  • Build, Lint, and Format Commands - All bun commands
  • Folder Structure - Component organization and API integration patterns
  • Libraries - Tailwind, shadcn/ui, SWR, zod, react-hook-form
  • Data Fetching Patterns - jsonFetcher and SWR hook examples
  • Coding Conventions - TypeScript, .d.ts patterns, exports, path aliases

The repository also has:

  • copilot-setup-steps.yml - Dev environment workflow
  • agents/code-reviewer.md - Code review agent
  • dependabot.yml - Dependency management

If you'd like any specific additions based on the documentation, please let me know what sections need to be added.

@Hye-Dev Hye-Dev closed this Dec 1, 2025
@Hye-Dev Hye-Dev deleted the copilot/set-up-copilot-instructions branch December 3, 2025 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants