Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

copilot-instructions.md and agents.md

Abierto
  • ¿Algo no está bien?
#7 0 comentarios 1 reacción 1 asignado Ver en GitHub

@copilot-swe-agent ya está trabajando en esto.

Desde el 15/8/2025.

  • #8 de @copilot-swe-agent — abierto

Evaluación

Este issue todavía no se ha evaluado.

Descripción

We need to add specific files and content into this repository. To do that, think through and analyze the following plan. After careful analysis, perform each step exactly as stated.

Scan the repository to get a complete understanding of what it contains.
Perform the following steps to create the appropriate files. If a file already exists DO NOT PERFORM that step. We do not want to overwrite existing copilot-instructions.md or agents.md files. Create a GitHub Copilot instructions file named copilot-instructions.md in the .github directory at the root of the repository. See "## Copilot Instructions Example" below and follow that general template format based upon what you found in this repository.
Create an agents.md file at the root of the repository. See "## agents.md Example" below and follow that general template format based upon what you found in this repository. In addition to the provided template below, research the additional template available at https://github.com/gakeez/agents_md_collection/tree/main/examples so that you understand your options for creating the agents.md file.
DO NOT COPY the actual content from the templates that are mentioned. Use the templates to understand the format that should be used to create the files.

Copilot Instructions

Specify coding practices, preferred technologies, or project requirements, so generated code follows your standards.
Set rules for code reviews, such as checking for security vulnerabilities or performance issues.
Provide instructions for generating commit messages or pull request titles and descriptions.

agents.md Instructions

Create Your Agents.md File

  1. Start by creating a file named AGENTS.md in your repository.
  2. Document Project Structure
    Within your Agents.md file, clearly document your project's structure, architecture, and organization. This critical information helps OpenAI Codex understand the codebase layout and relationships between components.
  3. Define Coding Conventions
    Agents.md should thoroughly document your project's coding standards, style guidelines, naming conventions, and other practices. When OpenAI Codex has access to these conventions, it can generate code that seamlessly integrates with your existing codebase.
  4. Include Testing Protocols
    In your Agents.md file, provide clear instructions on how to run tests, what testing frameworks are used, and any specific testing requirements. This enables OpenAI Codex to generate not only functional code but also appropriate test cases.
  5. Specify PR Guidelines
    For teams using OpenAI Codex in collaborative environments, include instructions about Pull Request messages, formatting, and specific information that should be included when creating PRs. This helps ensure that code contributions follow your team's workflow.
Lenguaje dominante
TypeScript
Estrellas
27
Forks
22
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure-Samples/azure-ai-agents-javascript

Todos los issues de Azure-Samples/azure-ai-agents-javascript

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.