EPIC Review documentation for best practices
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
Start with the Scope and the CMS 4/CMS 5 applicability decision. The issue names no files or tests; completion would require an agreed documentation review scope and applying the listed best-practice criteria while leaving the explicitly out-of-scope items untouched.
由索引模型根据 Issue 内容生成。
描述
Scope
The primary purpose of this PR is to ensure that:
- code examples exhibit best practices, including but not limited to:
- always using namespaces, with exception of
PageandPageController - always using
::create()instead ofnewfor instantiatingInjectableclasses - would pass linting
- always using namespaces, with exception of
- code examples are consistent
- written documentation encourages best practice, especially when documenting alternatives that should be only used if they're specifically needed to be done that way
- written documentation is clear and understandable
- written documentation always uses an API link the first time a class, method, or property is referenced on that page
- method names referenced in written documentation end with
()
Explicitly out of scope
- grammatical or spelling mistakes in existing writing
- inconsistent markdown styling
- anything else that will be covered by https://github.com/silverstripe/developer-docs/issues/11
Decisions to be made:
- Does this only apply to CMS 5 doc (like #212 did) or to CMS 4 AND 5 docs?
- 主要语言
- 没有语言数据
- 星标
- 7
- 派生
- 76
- 平均合并
- 1 天 12 小时
- 30 天内合并 PR
- 4
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
silverstripe/developer-docs 的其他 Issue
-
6.0.0 changelog: DBField formatters on array getters now render empty可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 1/5 1 小时以内 新手友好度 88/100
silverstripe/developer-docs#912 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 82/100
silverstripe/developer-docs#911 ·
-
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rules未关闭affects/v6 complexity/low impact/low type/docs
难度 1/5 1 小时以内 新手友好度 92/100
silverstripe/developer-docs#909 · 1 条评论 ·
-
affects/v6 complexity/low impact/low type/docs
难度 2/5 1-3 小时 新手友好度 88/100
silverstripe/developer-docs#908 · 1 条评论 ·
-
affects/v5 affects/v6 complexity/low impact/low type/docs
难度 1/5 1 小时以内 新手友好度 90/100
silverstripe/developer-docs#907 · 1 条评论 ·
查看 silverstripe/developer-docs 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 82/100
-
documentation good first issue hacktoberfest help wanted
难度 2/5 1-3 小时 新手友好度 78/100
Finntegrate/tapio#200 ·
维护者通常 1 天内回复
-
enhancement
难度 1/5 1 小时以内 新手友好度 88/100
-
难度 1/5 1 小时以内 新手友好度 88/100
-
[bug] README_CN.md 的通道清单缺 Telegram 与 Discord，与 README.md 不一致可能已有人在做 @sxh313 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 62/100
TencentCloud/Octop#1768 · 1 条评论 ·
维护者通常 1 天内回复