Add the Review.Incremental Setting and Documentation

オープン
#179 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
53/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript

調査の方向性

Start by reading the repo config schema in packages/schema and trace where parsed config is validated and exposed. Then find the configuration guide and dashboard repository settings UI to check whether settings are editable there. Done means the flag defaults to false, unset behavior stays the same, documentation includes an example, and the listed checks pass.

索引モデルが issue の本文から書いたものです。

説明

enhancement good first issue

Goal

Add the review.incremental opt-in setting to the repository review config schema and document it.

Background

Incremental reviews (see parent issue) need a per-repository opt-in flag. The config schema lives in packages/schema. The setting must default to false so existing repositories keep the current full-diff behavior.

This sub-issue is part of the parent issue: incremental reviews on synchronize events.

What to Build

  • Add incremental?: boolean to the RepoConfig review section in packages/schema (default false)
  • Validate and expose the flag wherever repo config is parsed
  • Document the setting in the configuration guide
  • Add the toggle to the dashboard repository settings UI, if repo settings are editable there

Done When

  • review.incremental parses and validates in the repo config schema
  • Default is false and unset behaves exactly as today
  • Configuration guide documents the setting with an example
  • Dashboard repo settings UI exposes the toggle (if applicable)
  • npm run typecheck, npm test, and npm run lint all pass
主要言語
TypeScript
スター
125
フォーク
23
平均マージ
2日 13時間
マージ済み PR(30日)
12

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

devarshishimpi/codra のほかの issue

devarshishimpi/codra の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。