-
-
Notifications
You must be signed in to change notification settings - Fork 102
Add Table of Contents (TOC) to CONTRIBUTING.md #882
Copy link
Copy link
Open
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentationGood First IssueGood for newcomers or first time contributors.Good for newcomers or first time contributors.PyCon DE 2026Issues marked with this label are specifically intended for participants of the PyCon DE tutorial.Issues marked with this label are specifically intended for participants of the PyCon DE tutorial.
Metadata
Metadata
Assignees
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentationGood First IssueGood for newcomers or first time contributors.Good for newcomers or first time contributors.PyCon DE 2026Issues marked with this label are specifically intended for participants of the PyCon DE tutorial.Issues marked with this label are specifically intended for participants of the PyCon DE tutorial.
This issue is currently reserved for participants of a tutorial at PyCon DE & PyData 2026. It is part of a guided session, so contributions may be coordinated during the event. If the issue is not resolved during the tutorial, it will be reopened for general contributions afterward. Thank you for your understanding and interest in contributing 💜
Description
The current
CONTRIBUTING.mdfile contains well-structured sections, but it lacks a Table of Contents (TOC), which makes it harder for contributors to quickly navigate the document, especially as it grows.Adding a TOC at the top of the file will improve readability and help users jump directly to the section they need.
Goal
Add a Table of Contents to the top of
CONTRIBUTING.mdwith links to all major sections.What needs to be done
Add a TOC below the main title (
# Contributing)Include links to all main sections:
Ensure each item links correctly using Markdown anchor links
Example
Here is an example of how the TOC should look:
Acceptance criteria
CONTRIBUTING.md