Use repository guidance files in code reviews

Đang mở
#154 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
ai-infra-agents, backend

Hướng nghiên cứu

Start with the work breakdown in issues #159 and #160 to understand how discovery, folder scope, and safe use are divided. Then locate the review flow and tests for guidance discovery and application; the issue does not name specific files. Done means supported guides apply to the right changed files, failures to read them do not stop reviews, and tests cover scope, safety, and missing files.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement good first issue help wanted

Goal

Let Codra use guidance files already present in a repository so its reviews follow the team's conventions and architecture.

Files and scope

Support AGENTS.md files and an optional CODRA.md review guide. A guide applies to files in its folder and its subfolders. Root level guidance applies across the repository, while more specific guidance can add to or refine it for a smaller part of the codebase.

Work breakdown

Safety and reliability

Guidance files are repository content. They can inform code review, but cannot override Codra's own rules or ask Codra to reveal secrets. Missing, unreadable, or oversized files must not prevent a review from running.

Done when

  • Codra finds the supported guidance files and applies them to the right changed files.
  • The supported file names, scope rules, and size limits are documented.
  • A review still runs if guidance is missing or cannot be read.
  • Tests cover discovery, directory scope, safety, and missing files.

Before closing

  • npm run typecheck, npm test, and npm run lint all pass.
  • Any backend changes work in both Cloudflare Workers and Node/Docker.
  • Tests cover the changed behavior in each affected runtime.
Ngôn ngữ chính
TypeScript
Star
125
Fork
23
Merge trung bình
2 ngày 13 giờ
Pull request đã merge (30 ngày)
12

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 devarshishimpi/codra

Tất cả issue của devarshishimpi/codra

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.