Great README examples (documentation, markdown)
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- markdown
调研方向
首先，将仓库当前的 README 与 issue 中链接的示例进行对照审查。issue 没有指定目标文件、具体更改或验收标准，因此请在开始之前定义 README 的范围和一份可衡量的完成检查清单。
由索引模型根据 Issue 内容生成。
描述
What should a README be?
Projects should have READMEs that have
- Easy to understand the purpose
- At-a-glance visual usage / demo
- Actual demo
- Easy deploy instructions
Great READMEs
Master Markdown
(honestly, it's easy)
- 主要语言
- JavaScript
- 星标
- 63
- 派生
- 3
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
BeyondCodeBootcamp/beyondcodebootcamp 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 25/100
BeyondCodeBootcamp/beyondcodebootcamp#22 · 1 个 reaction ·
-
难度 5/5 一周以上 新手友好度 25/100
BeyondCodeBootcamp/beyondcodebootcamp#21 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 30/100
-
难度 3/5 1-2 天 新手友好度 35/100
BeyondCodeBootcamp/beyondcodebootcamp#19 · 1 个 reaction ·
-
BeyondCodeBootcamp/beyondcodebootcamp#18 · 20 条评论 · 7 个 reaction · 已指派 1 人 ·
查看 BeyondCodeBootcamp/beyondcodebootcamp 的全部 Issue
相似的 Issue
-
bug customer-eng Durable Agents Inngest status: needs triage
难度 2/5 1-3 小时 新手友好度 82/100
-
optimization optimization:agents-md-curator
难度 2/5 1-3 小时 新手友好度 75/100
githubnext/gh-aw-cao#13475 ·
-
[BUG]: "Clear All" in Settings doesn't clear the saved analysis, old data comes back after reload 未关闭bug
难度 2/5 1-3 小时 新手友好度 88/100
AOSSIE-Org/OrgExplorer#253 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
oxc-project/oxc#26944 ·
-
ai-observability bug team/ai-observability
难度 2/5 1-3 小时 新手友好度 78/100