CONTRIBUTING.md not created or staged when it is brought up in chapter 2.2
まだ誰も着手していません。
評価
- 難易度
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
certification
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
bisq-network/support#2181 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
tutorial updates オープン
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
sveltejs/svelte.dev#2241 ·