Skip to content

Add Table of Contents (TOC) to CONTRIBUTING.md #882

@camilamaia

Description

@camilamaia

⚠️ Reserved for Conference 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.md file 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.md with links to all major sections.

What needs to be done

  • Add a TOC below the main title (# Contributing)

  • Include links to all main sections:

    • Create a GitHub Account
    • Fork the repository
    • Set up your environment
    • Choose a task to work on
    • Claim the issue
    • Open your first pull request
    • Final notes
  • Ensure each item links correctly using Markdown anchor links

Example

Here is an example of how the TOC should look:

## Contents

- [1. Create a GitHub Account](#1-create-a-github-account)
- [2. Fork the repository](#2-fork-the-repository)
- [3. Set up your environment](#3-set-up-your-environment)
- [4. Choose a task to work on](#4-choose-a-task-to-work-on)
- [5. Claim the issue](#5-claim-the-issue)
- [6. Open your first pull request](#6-open-your-first-pull-request)
- [Final notes](#final-notes)

Acceptance criteria

  • A TOC is added at the top of CONTRIBUTING.md
  • All links correctly navigate to their respective sections
  • Formatting is clean and easy to read
  • No existing content is broken or altered unintentionally

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentationGood First IssueGood for newcomers or first time contributors.PyCon DE 2026Issues marked with this label are specifically intended for participants of the PyCon DE tutorial.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions