Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Add a Table of Contents to README

クローズ 初心者向け
#26 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

関連するプルリクエストがすでにマージされています。

  • #27 @rafaelnacle による — マージ済み

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
92/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
markdown
領域
documentation

調査の方向性

READMEを開き、主要なセクション見出し、特にバナーと「Why Metcode」セクションを確認します。バナーと「Why Metcode」の間に、各主要セクションへのクリック可能なリンクを含む目次を追加します。READMEだけが変更され、すべての主要セクションが機能するリンクで示されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Go
スター
1
フォーク
2
平均マージ
16時間 20分
マージ済み PR(30日)
13

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Edwin-metcalf/MetCode のほかの issue

Edwin-metcalf/MetCode の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。