CONTRIBUTING.md not created or staged when it is brought up in chapter 2.2
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 50/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- git
- Lĩnh vực
- documentation
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- CSS
- Star
- 6.6k
- Fork
- 2.1k
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của progit/progit2
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Semi-stale link for GitHosting Đang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
enhancement
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
-
enhancement
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 65/100
Tất cả issue của progit/progit2
Issue tương tự
-
The correction-threshold rationale says 17 restraint cases collide; the current corpus has 16 Đang mởarea:dictation documentation P2
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
uttrflow/uttrflow-swift#1180 ·
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
githubnext/gh-aw-workshop#3692 ·
-
agent/guide documentation hive/hosted-available-lke648397-260827-5n31
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
-
kind/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
falcosecurity/falco-website#1601 ·
-
Improve privacy considerations Đang mởspecification
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 78/100
WICG/webmonetization#729 ·