Suggestion: Document best practices and references for contributors
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 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 分钟
- 30 天内合并 PR
- 17
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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 于 21 天前认领。 未关闭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
-
getchaintips leaves out the active tip once a header is staged on it, where Core always lists it未关闭
难度 2/5 1-3 小时 新手友好度 88/100
btclib-org/btclib-node#2158 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
dbt-msft/dbt-sqlserver#897 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
Gathin23/cleanyourtv#2770 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
vllm-project/vllm#64845 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
dekobon/big-code-analysis#1729 ·
维护者通常 1 天内回复