Add a table of contents to the README
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 90/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- markdown, python
调研方向
修改位于 dev 分支上的 README.md：在项目介绍和 Installation 之间添加一个 ## Contents 部分。先阅读现有的二级标题，然后按当前顺序，使用 [Installation](#installation) 这样的 GitHub 锚点链接为每个标题创建链接。预览渲染后的 Markdown，确认每个链接都指向对应的标题，并保持现有示例和说明不变。当列表按顺序覆盖所有二级章节且 PR 指向 dev 时，即完成。
由索引模型根据 Issue 内容生成。
描述
What to do
- Create a topic branch from
dev. - Edit README.md.
- Add a
## Contentssection after the project introduction and before Installation. - Link to each existing level-two section, in its current order. For example:
[Installation](#installation)and[Quick Start](#quick-start). - Preview the rendered Markdown and check that each link reaches the matching heading.
- 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 分钟
- 30 天内合并 PR
- 8
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
相似的 Issue
-
难度 1/5 1-3 小时 新手友好度 88/100
aws-samples/sample-per-model-bedrock#782 ·
维护者通常 1 天内回复
-
Google text documents are base64-encoded twice可能已有人在做 @feiiiiii5 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
coveragepy/coveragepy#2364 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100