Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 16, 2025

This PR adds an AGENTS.md file to configure instructions for GitHub Copilot coding agents working on this repository, as requested in issue #[issue_number].

What's Changed

Created a comprehensive AGENTS.md file that provides detailed guidance for GitHub Copilot coding agents working on the Socialify project. This file follows the best practices documented at https://gh.io/copilot-coding-agent-tips and uses the recommended AGENTS.md format from https://agents.md.

Content Overview

The AGENTS.md file includes:

  • Project Overview: Description of Socialify as a social media preview image generator for GitHub repositories, including the tech stack (Next.js 15, React 19, TypeScript, Tailwind CSS, DaisyUI)
  • Development Environment Setup: Prerequisites, installation steps, and environment variable configuration
  • Project Structure: Directory organization and explanation of key directories (/app, /src, /common, etc.)
  • Code Style and Formatting: Comprehensive Biome configuration details, style rules, and important conventions
  • Testing Guidelines: Instructions for Jest unit tests and Playwright end-to-end tests
  • Building and Deployment: Build commands and artifact information
  • Version Control: Changeset workflow and PR guidelines
  • Common Patterns: Next.js App Router usage, API routes, image generation, and styling patterns
  • Key Technologies: Deep dive into Next.js 15 App Router, Satori/RESVG image generation pipeline, and GitHub integration
  • Debugging and Troubleshooting: Common issues and their solutions
  • Best Practices for AI Agents: Specific guidance emphasizing minimal changes, early testing, and following existing patterns

Benefits

This documentation will help GitHub Copilot coding agents:

  • Understand the project architecture and technology choices
  • Follow the established code style and conventions
  • Use the correct tools (Biome, pnpm, Jest, Playwright)
  • Make minimal, surgical changes that align with project standards
  • Navigate the codebase more effectively
  • Avoid common pitfalls and issues

Resolves #[issue_number]

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:

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. Use AGENTS.md file name and format.

</issue_description>

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

Fixes #716


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI assigned Copilot and wei Oct 16, 2025
@changeset-bot
Copy link

changeset-bot bot commented Oct 16, 2025

⚠️ No Changeset found

Latest commit: 76a72c7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify
Copy link

netlify bot commented Oct 16, 2025

Deploy Preview for github-socialify ready!

Name Link
🔨 Latest commit 76a72c7
🔍 Latest deploy log https://app.netlify.com/projects/github-socialify/deploys/68f0de25f01d9300087adb3c
😎 Deploy Preview https://deploy-preview-717--github-socialify.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.

@coderabbitai
Copy link

coderabbitai bot commented Oct 16, 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.

Copilot AI changed the title [WIP] Configure Copilot instructions for the repository ✨ Set up Copilot instructions Oct 16, 2025
Copilot AI requested a review from wei October 16, 2025 12:01
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