Redundant commitConvention and repoType added to .all-contributorsrc file on add

クローズ
#369 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

@lwasser がすでに取り組んでいます。

2026年10月27日 から。

  • #542 @JoshuaKGoldberg による — マージ済み
  • #546 @matbrgz による — マージされずにクローズ
  • #585 @lwasser による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
45/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
javascript
領域
cli

調査の方向性

最小限の .all-contributorsrc と npx all-contributors-cli add JoshuaKGoldberg doc を使って、まず問題を再現します。add コマンドの設定更新パスを追跡し、文書化されたデフォルト値がどのように書き込まれるかを確認します。これらのプロパティを持たない既存のファイルがコマンド実行後も変更されず、再現ケースのカバレッジがあることを完了条件とします。

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

説明

type: bug

Describe the bug

.all-contributorsrc files shouldn't need to include commitConvention or repoType properties. They both have default values as documented on https://allcontributors.org/docs/en/bot/configuration:

  • commitConvention: "angular"
  • repoType: "github"

But, running npx all-contributors-cli add ... is adding commitConvention or repoType properties with their default values to .all-contributorsrc files that don't have them explicitly.

 {
 	"contributors": [ ... ],
 	"projectName": "repros-example",
 	"projectOwner": "JoshuaKGoldberg",
+	"repoType": "github",
+	"commitConvention": "angular"
 }

To Reproduce

See https://github.com/JoshuaKGoldberg/repros/tree/all-contributors-cli-add-field-defaults.

  1. Create a repo with a minimal .all-contributorsrc
  2. Run npx all-contributors-cli add JoshuaKGoldberg doc

Expected behavior

The .all-contributorsrc file shouldn't have commitConvention or repoType added, since they have documented defaults.

Additional context

I filed a bunch of feature requests over on https://github.com/all-contributors/all-contributors for more default-friendly behavior. https://github.com/all-contributors/all-contributors/issues/808 is something of a hub for them.

主要言語
JavaScript
スター
425
フォーク
152
平均マージ
2日 20時間
マージ済み PR(30日)
17

環境構築

はじめの一歩

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

all-contributors/cli のほかの issue

all-contributors/cli の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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