General naming consistencies -- fix + document + ensure best practices moving forward:
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- リファクタリング
- 明瞭さ
- 説明が足りない
- 活発さ
- 静か
- 技術スタック
- python
調査の方向性
まず、issue と burr/integrations/hamilton.py にある integration の命名例、特に参照されている live-check の使用方法を確認します。既存の a_、b_、plugin パッケージ名と、それらのインストールマッピングを調査します。命名規則、必要な移行、将来の integration の一貫性を保つ方法が文書化され、合意されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
Too early in the library to have these -- we need to keep backwards compatibility but want to make it consistent/easy to reason about.
Specifically:
a_<plugin>versusplugin(done to distinctify async)- When should/should these ever live together?
- Should we have a separate
aiopackage? (oraorasync(which isn't allowed)
b_<plugin>versus- Some have these and some don't (
integrations.b_aiosqlite, etc...) - Confusing with
a_(aimplies async,bimpliesburr,a_bimplies async Burr I suppose?) - Done initially to disambiguate import names, although not consistently
- Some have these and some don't (
plugin-> package extension name configuration- No clear mapping here
- Makes it really hard to understand what needs to be installed
- Maybe we have live checks -- should probably consistently be using this tool
Describe the solution you'd like
- Come up with best practices
- Document/ensure them, make any migrations needed
- Figure out how to keep it consistent in the future (open-ended)
Describe alternatives you've considered
Chaos :)
Additional context
Add any other context or screenshots about the feature request here.
- 主要言語
- Python
- スター
- 2.6k
- フォーク
- 199
- 平均マージ
- 3日 10時間
- マージ済み PR（30日）
- 6
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/burr のほかの issue
-
status/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 2 日以内に返信
-
Streaming Event type, type hint, should support union type対応中かも @mvanhorn が 183 日前に担当しました。 オープンarea/streaming area/typing good first issue help wanted kind/bug priority/high
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 2 日以内に返信
-
Add more instructions for applying ORM migrations for S3 deployment対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンarea/storage area/ui help wanted kind/documentation priority/low
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 2 日以内に返信
-
Add documentation on how to run the Burr UI server再び着手できるかも @iamSerafinnn が 122 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンarea/ui good first issue kind/documentation priority/low
難易度 2/5 半日 初心者へのやさしさ 68/100
メンテナーはふだん 2 日以内に返信
-
status/needs-triage
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
pytest-dev/pluggy#757 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
NousResearch/hermes-agent#134960 ·
メンテナーはふだん 1 日以内に返信
-
HTML backend: `<br>` leaks the internal sentinel U+E000 into list items, headings and captions対応中かも @morten-lagabote が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
docling-project/docling#4671 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
good first issue hacktoberfest infra
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信