Skip to content

✨ Add AGENTS.md structured context for the repository#513

Open
Copilot wants to merge 3 commits intomainfrom
copilot/set-up-copilot-instructions
Open

✨ Add AGENTS.md structured context for the repository#513
Copilot wants to merge 3 commits intomainfrom
copilot/set-up-copilot-instructions

Conversation

Copy link
Contributor

Copilot AI commented Oct 11, 2025

Overview

This PR sets up AI structured context for the ORAS documentation website repository.

Changes

Added AGENTS.md (see https://agents.md/) with comprehensive guidance for AI coding assistants, including:

Repository Context

  • Technology stack overview (Docusaurus 2, React, MDX, JavaScript)
  • Purpose and key features of the documentation website
  • Current supported versions (1.1, 1.2, 1.3)

Critical File Guidelines

  • Do NOT modify auto-generated command documentation files in versioned_docs/version-*/commands/*.mdx
    • These are generated from ORAS CLI source via npm run refresh-commands
    • Include warning comments to prevent accidental modification
  • Build artifacts and package-lock.json handling
  • Key configuration files and their purposes

Development Workflows

  • Local development setup and commands
  • Build, test, and validation processes
  • Vale linting for documentation style
  • Link checking for internal markdown references

Contribution Standards

  • Code style conventions for MDX and React/JavaScript
  • Commit message format (Conventional Commits)
  • DCO sign-off requirements
  • PR process and CI/CD checks

Common Tasks

  • Step-by-step guides for:
    • Adding new documentation pages
    • Updating the blog
    • Fixing broken links
    • Adding adopters/registries

Benefits

This will help AI assistants:

  • Avoid modifying auto-generated files that would be overwritten
  • Follow the correct build and test procedures
  • Adhere to project conventions and style guidelines
  • Understand the versioned documentation structure
  • Make appropriate, minimal changes that align with repository practices

Resolves #[issue_number]

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 #512


💡 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 changed the title [WIP] Configure instructions for Copilot in repository ✨ Add GitHub Copilot instructions for the repository Oct 11, 2025
Copilot AI requested a review from TerryHowe October 11, 2025 15:08
@TerryHowe TerryHowe marked this pull request as ready for review October 11, 2025 15:11
Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

/lgtm

Copilot AI added 2 commits November 5, 2025 06:03
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
@TerryHowe TerryHowe force-pushed the copilot/set-up-copilot-instructions branch from 15d6821 to 2ff1fcc Compare November 5, 2025 13:04
@TerryHowe TerryHowe changed the title ✨ Add GitHub Copilot instructions for the repository ✨ Add AGENTS.md structured context for the repository Nov 5, 2025
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
@github-actions
Copy link

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 30 days.

@github-actions github-actions bot added the Stale label Dec 27, 2025
@TerryHowe TerryHowe removed the Stale label Dec 28, 2025
@TerryHowe TerryHowe added this to the v1.4 milestone Dec 28, 2025
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 AGENTS.md instructions

2 participants