Suggestion: Document best practices and references for contributors
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 32/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
Read the linked discussion on pull request #3849 and review the README.rst placement question. Ask maintainers to settle whether the guidance belongs in the README or a project wiki, then document the listed references and dictionary-entry advice; done means the location and content are agreed and published.
索引モデルが issue の本文から書いたものです。
説明
It would be beneficial to create a list of suggestions and best practices for contributors, drawing from advice provided by maintainers in previous issues and pull requests. The recommendations could include:
- Use the OED (Oxford English Dictionary) as the primary reference for English word spellings.
- Use SCOWL and Friends as the open-source English dictionary of reference for spell checkers. Let it have the last word.
- Utilize the Google Ngram Viewer to check the frequency and commonality of terms or proposed corrections.
- When adding dictionary entries, always include all verbal forms (e.g., present, past, participle) and both singular and plural nouns.
A point for discussion: Should this advice be added to the main README.rst, understanding that it could clutter the file, or should we create and use a project wiki page to keep the README concise?
Feedback and preferences from maintainers and contributors on the above structure would be appreciated.
Based on https://github.com/codespell-project/codespell/pull/3849#discussion_r2628371422.
- 主要言語
- Python
- スター
- 2.4k
- フォーク
- 531
- 平均マージ
- 15時間 55分
- マージ済み PR（30日）
- 17
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
codespell-project/codespell のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
codespell-project/codespell#3997 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 63/100
codespell-project/codespell#3965 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Add "marcos"対応中かも @ekanshul が 20 日前に担当しました。 オープンdictionary
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
codespell-project/codespell#3920 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
question
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
codespell-project/codespell#4005 ·
メンテナーはふだん 1 日以内に返信
-
duplicate question
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
codespell-project/codespell#3998 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
codespell-project/codespell の issue をすべて見る
似ている issue
-
priority middle
難易度 1/5 1時間未満 初心者へのやさしさ 62/100
KATO-Hiro/AtCoderClans#12940 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 76/100
huggingface/huggingface_hub#5283 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
bug example
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信