Skip to content

Add GitHub Copilot instructions for workshop app onboarding#75

Merged
SmokeHound merged 2 commits intomainfrom
copilot/fix-6e5e78bb-e1bd-4f0a-b851-a37b86388ccf
Sep 10, 2025
Merged

Add GitHub Copilot instructions for workshop app onboarding#75
SmokeHound merged 2 commits intomainfrom
copilot/fix-6e5e78bb-e1bd-4f0a-b851-a37b86388ccf

Conversation

Copy link
Contributor

Copilot AI commented Sep 10, 2025

This PR adds comprehensive GitHub Copilot instructions to help onboard developers and improve code suggestions for the Workshop App monorepo.

What's Added

A new .github/copilot-instructions.md file that provides GitHub Copilot with detailed context about:

  • Repository structure - Overview of the monorepo layout with frontend, backend, and shared components
  • Technology stack - Node.js/Express backend with SQLite, vanilla JavaScript frontend
  • Architecture patterns - JWT authentication, role-based access control, RESTful API design
  • Code patterns - Examples for consistent API routes, error handling, and frontend utilities
  • Security guidelines - Best practices for input validation, SQL injection prevention, and XSS protection
  • Development workflow - Guidelines for adding features, database changes, and maintaining code style

Why This Helps

With these instructions, GitHub Copilot will:

  • Suggest code that follows the existing patterns and conventions
  • Understand the role-based authentication system (admin, user, tech)
  • Generate API routes with proper security middleware
  • Suggest frontend code that uses the existing utility functions
  • Maintain consistency with the vanilla JavaScript and modular architecture
  • Follow the established security practices and error handling patterns

Example Benefits

When a developer starts typing:

router.get('/admin/users', 

Copilot will now suggest adding authentication and role checking:

router.get('/admin/users', authenticateToken, requireRole('admin'), (req, res) => {
  // Handler implementation
});

This onboarding documentation ensures new contributors and AI assistance align with the project's architecture and best practices from day one.


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

@netlify
Copy link

netlify bot commented Sep 10, 2025

Deploy Preview for workshop-order ready!

Name Link
🔨 Latest commit a6703cd
🔍 Latest deploy log https://app.netlify.com/projects/workshop-order/deploys/68c0d578ae583e00081981de
😎 Deploy Preview https://deploy-preview-75--workshop-order.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@SmokeHound
Copy link
Owner

Co-authored-by: SmokeHound <23314326+SmokeHound@users.noreply.github.com>
Copilot AI changed the title [WIP] Onboard this repo by creating a copilot instructions.md file in a .github/ directory Add GitHub Copilot instructions for workshop app onboarding Sep 10, 2025
Copilot AI requested a review from SmokeHound September 10, 2025 01:34
Copy link
Contributor Author

Copilot AI commented Sep 10, 2025

github_copilot-instructions.md
@copilot

I can see you've attached a github_copilot-instructions.md file. Could you clarify what you'd like me to do with it? Should I:

  1. Replace the current .github/copilot-instructions.md file with the content from your attachment?
  2. Merge specific sections from your file into the existing one?
  3. Compare and update based on differences?

I can't directly access the attachment, so if you could share the content or specific changes you'd like me to make, I'll be happy to update the file accordingly.

@SmokeHound SmokeHound marked this pull request as ready for review September 10, 2025 01:49
Copilot AI review requested due to automatic review settings September 10, 2025 01:49
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

@SmokeHound SmokeHound merged commit fd9b462 into main Sep 10, 2025
5 of 6 checks passed
@SmokeHound SmokeHound deleted the copilot/fix-6e5e78bb-e1bd-4f0a-b851-a37b86388ccf branch September 10, 2025 01:49
Copy link
Contributor

Copilot AI left a comment

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 adds comprehensive GitHub Copilot instructions to help onboard developers and improve AI-generated code suggestions for a workshop management monorepo. The instructions provide detailed context about the repository structure, technology stack, and coding patterns to ensure consistent code generation.

Key changes:

  • Creates a new GitHub Copilot instructions file with detailed repository documentation
  • Documents architecture patterns including JWT authentication, role-based access control, and RESTful API design
  • Provides code examples and security guidelines for both frontend and backend development

- No build process - direct serving of static files

### Database Design
- SQLite database with manual schema management
Copy link

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

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

[nitpick] The term 'manual schema management' could be clearer. Consider specifying what this means (e.g., 'SQLite database with schema managed through direct SQL scripts' or 'SQLite database without automated migrations').

Copilot uses AI. Check for mistakes.

## Environment Configuration

Required environment variables (see `.env-example`):
Copy link

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

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

[nitpick] The reference to .env-example assumes this file exists in the repository. Since this is documentation for Copilot instructions, it would be helpful to clarify the actual location of environment variable examples or remove the reference if the file doesn't exist.

Copilot uses AI. Check for mistakes.
Copy link
Owner

@SmokeHound SmokeHound Sep 10, 2025

Choose a reason for hiding this comment

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

@SmokeHound SmokeHound restored the copilot/fix-6e5e78bb-e1bd-4f0a-b851-a37b86388ccf branch September 10, 2025 01:55
@SmokeHound SmokeHound deleted the copilot/fix-6e5e78bb-e1bd-4f0a-b851-a37b86388ccf branch September 10, 2025 01:56
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.

3 participants