DOI-USGS / DOI-USGS/dataretrieval-python
Use adapter terminology for configuration scope
- 主要言語
- Python
- スター
- 265
- フォーク
- 63
- 平均マージ
- 1日 20時間
- マージ済み PR(30日)
- 19
説明
## Parent
#406
## What to build
Correct configuration prose, comments, and caller-facing guidance that describe a setting or default as scoped to a service when the package's configuration scope is the adapter. Preserve uses of "service" that genuinely name an external system, host behavior, upstream capacity, or service-neutral machinery.
The caller-facing invalid-configuration remedy must name real configuration objects and remain literally actionable. This is a wording correction only: do not rename identifiers, configuration classes, settings, adapter keys, or public parameters.
## Acceptance criteria
- [ ] Every configuration use of "service" names an external system rather than the scope of a setting, default, profile, or override.
- [ ] Every tuning-scope explanation consistently says adapter or names the adapter's configuration.
- [ ] The invalid-configuration remedy names valid package-wide and adapter-specific configuration objects, and following it produces a working call.
- [ ] Legitimate external-service, gateway, host, and service-neutral wording is unchanged.
- [ ] No public identifier, parameter, class, setting, configuration grammar, or behavior changes.
- [ ] The change description records that facade, leaf, and configuration-profile usage were audited and found compliant rather than mechanically rewritten.
- [ ] Documentation, wording-sensitive tests, the offline suite, lint, and architecture checks pass.
## Blocked by
None — can start immediately.
コントリビューションガイド
調査の方向性
まず、設定に関する文章、コメント、呼び出し元向けのガイダンスで “service” の使用箇所を検索し、次に文言に依存するテストと関係するドキュメントファイルを特定します。識別子や動作を変更せずに facade、leaf、configuration-profile の使用箇所を監査し、ドキュメントチェック、文言に依存するテスト、オフラインスイート、lint、アーキテクチャチェックを実行して、無効な設定への対処方法が実行可能であることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 活発
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100