Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

copilot-instructions.md and agents.md

Đang mở
  • Có gì không ổn?
#7 0 bình luận 1 reaction 1 người được giao Xem trên GitHub

@copilot-swe-agent đang làm issue này rồi.

Từ ngày 15/8/2025.

  • #8 của @copilot-swe-agent — đang mở

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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.
Ngôn ngữ chính
TypeScript
Star
27
Fork
22
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure-Samples/azure-ai-agents-javascript

Tất cả issue của Azure-Samples/azure-ai-agents-javascript

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.