Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add a Table of Contents to README

Đã đóng Phù hợp với người mới
#26 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Một pull request liên quan đã được merge.

  • #27 của @rafaelnacle — đã merge

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
92/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Mở README và xem lại các tiêu đề phần chính, đặc biệt là banner và phần “Why Metcode”. Thêm mục lục giữa banner và “Why Metcode”, với các liên kết có thể nhấp đến từng phần chính. Hoàn thành khi README là tệp duy nhất được thay đổi và mọi phần chính đều có liên kết hoạt động.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation good first issue

What

Add a table of contents to the top of the README right above the Why Metcode section, so underneath the banner.

Proposed Change

There is no table of contents for someone coming to the README to see what the readme has on it. There should be a small table of contents with all the major headings on the README so that someone can click on them and it will take them to the proper section of the README

Acceptance Criteria

Should only change the readme file. Should have a new table of contents section under the header and above why metcode. And should have all the main sections with clickable hyper references that take the user down to that section of the readme.

Ngôn ngữ chính
Go
Star
1
Fork
2
Merge trung bình
16 giờ 20 phút
Pull request đã merge (30 ngày)
13

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Edwin-metcalf/MetCode

Tất cả issue của Edwin-metcalf/MetCode

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.