Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 1, 2025

Overview

This PR adds comprehensive GitHub Copilot instructions to help the AI coding assistant provide more accurate and contextually relevant suggestions when working in this repository.

Changes

Created .github/copilot-instructions.md with detailed documentation covering:

Project Context

  • Overview: Description of Jain Wiki as an open, collaborative platform for mapping Jain temples and community places
  • Technology Stack: Nuxt 4, Vue 3, TypeScript, Tailwind CSS 4.x, Nuxt UI, and other key dependencies
  • Project Structure: Clear directory layout showing the organization of components, pages, layouts, and assets

Development Guidelines

  • Code Style: Vue 3 Composition API with <script setup> syntax patterns
  • TypeScript Conventions: Type safety practices and configuration details
  • Component Naming: PascalCase for files, kebab-case in templates, Home prefix for home page components
  • Styling: Tailwind CSS utility-first approach with specific color scheme (sky, teal, emerald, cyan)

Best Practices

  • SEO Optimization: How to properly use useSeoMeta() and useHead() composables with required meta tags
  • Icons: Usage of Nuxt Icon component with Heroicons, Lucide, and Material Symbols icon sets
  • Responsive Design: Mobile-first approach with Tailwind responsive prefixes
  • Common Patterns: Reusable component patterns like HomeSectionWrapper and NuxtLink usage

Development Commands

  • Development server runs on port 5016
  • Build, preview, and type checking commands
  • Configuration for site URL and API endpoints

Benefits

With these instructions, GitHub Copilot will:

  • Generate code that follows the established Vue 3 Composition API patterns
  • Suggest appropriate Tailwind CSS classes matching the project's design system
  • Create components with proper SEO meta tags
  • Understand the project structure and suggest appropriate file locations
  • Provide suggestions aligned with TypeScript conventions used in the codebase

References

This follows the best practices for configuring GitHub Copilot instructions as documented in GitHub's official guidance.


Note: This PR includes package-lock.json which was generated during testing. The project uses Bun as its primary package manager (as specified in package.json), but npm was used for build verification in the development environment.

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:

  • api.fontshare.com
    • Triggering command: node /home/REDACTED/work/website/website/node_modules/.bin/nuxt build (dns block)
  • api.fontsource.org
    • Triggering command: node /home/REDACTED/work/website/website/node_modules/.bin/nuxt build (dns block)
  • fonts.bunny.net
    • Triggering command: node /home/REDACTED/work/website/website/node_modules/.bin/nuxt build (dns block)
  • fonts.google.com
    • Triggering command: node /home/REDACTED/work/website/website/node_modules/.bin/nuxt build (dns block)

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

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)

Fixes #6

💡 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 and others added 2 commits October 1, 2025 13:25
Co-authored-by: adarshmadrecha <11911938+adarshmadrecha@users.noreply.github.com>
Co-authored-by: adarshmadrecha <11911938+adarshmadrecha@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions ✨ Set up GitHub Copilot instructions for repository Oct 1, 2025
Copilot AI requested a review from adarshmadrecha October 1, 2025 13:28
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