Use repository guidance files in code reviews

未關閉
#154 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
45/100
Issue 類型
功能
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
typescript

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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.
主要語言
TypeScript
星號
125
分支
23
平均合併
2 天 13 小時
30 天內合併 PR
12

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

devarshishimpi/codra 的其他 Issue

查看 devarshishimpi/codra 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。