Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 1, 2025

Setting up GitHub Copilot instructions for the repository

  • Understand the repository structure and technologies
  • Analyze existing documentation (README, DEVELOPMENT.md)
  • Create .github directory
  • Create .github/copilot-instructions.md with comprehensive instructions
  • Verify the file is properly formatted and complete
  • Address code review feedback - fixed SQL example to show proper table name validation
  • Improve documentation with cross-platform examples and clearer path formats
  • Clarify SQL injection example to show the actual risk (value concatenation)
  • Update references from "Local Sites" to "Studio" for accurate paths
  • Add links to WordPress Studio website and GitHub repository

The copilot-instructions.md file includes:

  • Project overview with WordPress Studio links and context
  • Architecture and IPC communication patterns
  • Code style and naming conventions
  • Security best practices with accurate SQL injection examples
  • Development workflow and common tasks
  • Testing guidelines with cross-platform examples using correct Studio paths
  • Platform-specific considerations with example paths
  • Common pitfalls to avoid
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 and others added 3 commits November 1, 2025 11:19
Co-authored-by: jonathanbossenger <180629+jonathanbossenger@users.noreply.github.com>
Co-authored-by: jonathanbossenger <180629+jonathanbossenger@users.noreply.github.com>
Co-authored-by: jonathanbossenger <180629+jonathanbossenger@users.noreply.github.com>
@jonathanbossenger jonathanbossenger marked this pull request as ready for review November 1, 2025 11:23
Co-authored-by: jonathanbossenger <180629+jonathanbossenger@users.noreply.github.com>
```

Example paths:
- macOS: `/Users/username/Local Sites/my-site/wp-content/database/.ht.sqlite`
Copy link
Owner

Choose a reason for hiding this comment

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

Replace Local Sites with Studio to match actual Studio sites location

Copy link
Owner

Choose a reason for hiding this comment

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

@copilot implement this update

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated all references from "Local Sites" to "Studio" to match the actual Studio sites location. Changes in commit 1a4c0b3.

Copilot AI changed the title [WIP] Set up Copilot instructions for the repository Add GitHub Copilot instructions for repository Nov 1, 2025

## Project Overview

WP SQLite is a desktop application for viewing and editing SQLite databases in WordPress Studio installations. It's built with Electron and React, providing a user-friendly interface for database management.
Copy link
Owner

Choose a reason for hiding this comment

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

Include link to WordPress Studio site https://developer.wordpress.com/studio/

Also include GitHub link to Studio repository https://github.com/Automattic/studio/

Copy link
Owner

Choose a reason for hiding this comment

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

@copilot implement this update

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added links to WordPress Studio website (https://developer.wordpress.com/studio/) and GitHub repository (https://github.com/Automattic/studio/) with additional context about WordPress Studio. Changes in commit 1a4c0b3.

Copy link
Owner

@jonathanbossenger jonathanbossenger left a comment

Choose a reason for hiding this comment

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

@copilot update this PR based on the review feedback

Co-authored-by: jonathanbossenger <180629+jonathanbossenger@users.noreply.github.com>
@jonathanbossenger jonathanbossenger merged commit 3553690 into main Nov 1, 2025
1 check passed
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