Add a table of contents to the README

オープン 初心者向け
  • 何か問題がありますか？
#5 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

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

調査の方向性

変更は dev ブランチの README.md に行います。プロジェクトの紹介と Installation の間に ## Contents セクションを追加してください。まず既存のレベル2見出しを確認し、現在の順序どおりに、[Installation](#installation) のような GitHub のアンカーリンクで各見出しへリンクします。レンダリングされた Markdown をプレビューして、各リンクが対応する見出しに移動することを確認し、既存の例と手順は変更しないでください。リストがすべてのレベル2セクションを順番どおりに含み、PR の対象が dev になっていれば完了です。

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

説明

enhancement good first issue help wanted

What to do

  1. Create a topic branch from dev.
  2. Edit README.md.
  3. Add a ## Contents section after the project introduction and before Installation.
  4. Link to each existing level-two section, in its current order. For example: [Installation](#installation) and [Quick Start](#quick-start).
  5. Preview the rendered Markdown and check that each link reaches the matching heading.
  6. Open a pull request targeting dev.

Acceptance criteria

  • The contents list links to all existing level-two sections, in order, excluding the Contents section itself.
  • Each link works in GitHub's rendered README.
  • The change only adds navigation to README.md and preserves its existing examples and instructions.

See CONTRIBUTING.md for the repository workflow. This is a documentation-only task, so no implementation regression tests or package-version change are required.

主要言語
Python
スター
1
フォーク
2
平均マージ
7分
マージ済み PR（30日）
8

環境構築

はじめの一歩

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

似ている issue

Python の issue をもっと見る

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

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