Additional Config File Options

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

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

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

  • #555 @matbrgz による — マージされずにクローズ

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
68/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
javascript
領域
cli

調査の方向性

CLI の既存の設定ファイル探索エントリーポイントから始め、現在の .all-contributorsrc のパスがどのように選択されるかを追跡します。周辺のテストと設定ドキュメントを確認し、提案された 3 つのパスが記載された優先順位でサポートされていること、また推奨されるファイル名がドキュメントに記載されていることを検証します。

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

説明

Is your feature request related to a problem? Please describe.
I believe there are several issues with the current standard of the config file being .all-contributorsrc in the root of the repo:

  1. Lack of extension makes the format ambiguous to some editors
  2. Config files in the root clutter things up and make the repo less readable, in my opinion

Describe the solution you'd like
I would propose supporting the following configs, with the CLI using the first one detected:

  • .all-contributors.json
    • This could potentially become the new standard recommended in the docs, also?
  • .config/all-contributors.json
  • .all-contributorsrc

Describe alternatives you've considered
Question not applicable.

Additional context
Adding support for .config directory is inspired by https://github.com/pi0/config-dir, a growing movement to try and organize config files in a set directory rather than the repo's root.

Additionally, I would be happy to contribute a PR for this is there is interest from the maintainers.

Thanks!

主要言語
JavaScript
スター
424
フォーク
151
平均マージ
2日 1時間
マージ済み PR(30日)
15

環境構築

はじめの一歩

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

all-contributors/cli のほかの issue

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

似ている issue

JavaScript の issue をもっと見る

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

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