CONTRIBUTING.md not created or staged when it is brought up in chapter 2.2
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 50/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- git
调研方向
Review chapter 2.2, especially the section on staging modified files and its CONTRIBUTING.md example. Check the walkthrough from a fresh reader’s perspective, then ensure the text explicitly accounts for creating and staging the file. Done means the instructions can be followed without an unstated step.
由索引模型根据 Issue 内容生成。
描述
General overview of your idea.
Maybe I am being dense, but if I am not mistaken. In chapter 2.2 under staging modified files. CONTRIBUTING.md is brought up, yet no such file has been created at this point and neither has it been staged yet.
Doing so is very straightforward but...
Let’s change a file that was already tracked. If you change a previously tracked file called
CONTRIBUTING.mdand then run your git status command again, you get something that looks like this:
...does not imply that you need to do these steps. Rather it implies that the reader has missed a step and should already have a created and staged CONTRIBUTING.md file.
A solution would be a snippet of code to create and stage CONTRIBUTING.md or explicit instructions to make and stage such a file in the text.
It goes without saying but thanks for the great resource. :)
What problem will this solve?
re-enable the reader to follow along with the instructions provided by the book.
Have you thought about other solutions?
Another solution would be to more explicitely tell the user to create and stage the CONTRIBUTING.md themselves.
Do you want to help with this enhancement idea?
No
- 主要语言
- CSS
- 星标
- 6.6k
- 派生
- 2.1k
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
progit/progit2 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
-
enhancement
难度 1/5 1 小时以内 新手友好度 82/100
-
enhancement
难度 1/5 1-3 小时 新手友好度 65/100
相似的 Issue
-
agent-ready documentation needs-triage
难度 1/5 1-3 小时 新手友好度 88/100
-
untriaged
难度 1/5 1 小时以内 新手友好度 88/100
dotnet/dotnet-api-docs#13095 ·
-
documentation
难度 1/5 1 小时以内 新手友好度 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" 未关闭
难度 1/5 1 小时以内 新手友好度 92/100
-
refactor
难度 2/5 1-3 小时 新手友好度 78/100