Prompt file imported from BAS-More/Archon (.github/prompts/create-rules.prompt.md). Copyright stays with the author.

Create Global Rules

Generate a .github/copilot-instructions.md file by analyzing the codebase and extracting patterns.

Objective

Create project-specific custom instructions that give Copilot context about:

• What this project is
• Technologies used
• How the code is organized
• Patterns and conventions to follow
• How to build, test, and validate

Phase 1: DISCOVER

Identify Project Type

First, determine what kind of project this is:

Analyze Configuration

Look at root configuration files:

package.json       → dependencies, scripts, type
tsconfig.json      → TypeScript settings
vite.config.*      → Build tool
*.config.js/ts     → Various tool configs

Map Directory Structure

Explore the codebase to understand organization:

• Where does source code live?
• Where are tests?
• Any shared code?
• Configuration locations?

Phase 2: ANALYZE

Extract Tech Stack

From package.json and config files, identify:

• Runtime/Language (Node, Bun, Deno, browser)
• Framework(s)
• Database (if any)
• Testing tools
• Build tools
• Linting/formatting

Identify Patterns

Study existing code for:

• Naming: How are files, functions, classes named?
• Structure: How is code organized within files?
• Errors: How are errors created and handled?
• Types: How are types/interfaces defined?
• Tests: How are tests structured?

Find Key Files

Identify files that are important to understand:

• Entry points
• Configuration
• Core business logic
• Shared utilities
• Type definitions

Phase 3: GENERATE

Create copilot-instructions.md

Use the template at .github/copilot-instructions-template.md as a starting point.

Output path: .github/copilot-instructions.md

Adapt to the project:

• Remove sections that don't apply
• Add sections specific to this project type
• Keep it concise - focus on what's useful

Key sections to include:

1. Project Overview - What is this and what does it do?
2. Tech Stack - What technologies are used?
3. Commands - How to dev, build, test, lint?
4. Structure - How is the code organized?
5. Patterns - What conventions should be followed?
6. Key Files - What files are important to know?

Optional sections (add if relevant):

• Architecture (for complex apps)
• API endpoints (for backends)
• Component patterns (for frontends)
• Database patterns (if using a DB)
• On-demand context references

Phase 4: OUTPUT

## Global Rules Created

**File**: `.github/copilot-instructions.md`

### Project Type

{Detected project type}

### Tech Stack Summary

{Key technologies detected}

### Structure

{Brief structure overview}

### Next Steps

1. Review the generated `copilot-instructions.md`
2. Add any project-specific notes
3. Remove any sections that don't apply
4. Optionally create reference docs for deeper context

Tips

• Keep copilot-instructions.md focused and scannable
• Don't duplicate information that's in other docs (link instead)
• Focus on patterns and conventions, not exhaustive documentation
• Update it as the project evolves