Skip to content

docs: complete the issue Add Table of Contents (TOC) to CONTRIBUTING.md #882#887

Open
nesaraLingarajaiah wants to merge 1 commit intoscanapi:mainfrom
nesaraLingarajaiah:main
Open

docs: complete the issue Add Table of Contents (TOC) to CONTRIBUTING.md #882#887
nesaraLingarajaiah wants to merge 1 commit intoscanapi:mainfrom
nesaraLingarajaiah:main

Conversation

@nesaraLingarajaiah
Copy link
Copy Markdown

Description

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

Motivation behind this PR?

Pydata 2026 conference issue solving for open source

What type of change is this?

Additional add on. Not a bug or a fix

Checklist

  • A changelog entry was added, or this PR does not require one. Instructions
  • Unit tests were added or updated as needed, or not required for this change. Instructions
  • All unit tests pass locally. Instructions
  • Docstrings or comments were added or updated as needed, or no documentation changes were required. Instructions
  • This PR does not significantly reduce code or docstring coverage.
  • Code follows the project’s style guidelines.
  • ScanAPI was run locally and the changes were manually verified, or this was not necessary. Instructions

Issue

Closes #882

@nesaraLingarajaiah nesaraLingarajaiah requested review from a team as code owners April 14, 2026 14:10
Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for supporting ScanAPI, and congratulations on your first contribution! A project committer will shortly review your contribution.

In the mean time, if you haven't had a chance please skim over the First Pull Request Guide which all pull requests must adhere to.

We hope to see you around!

@github-actions github-actions bot added the First Contribution First contribution to the project. label Apr 14, 2026
Copy link
Copy Markdown
Member

@camilamaia camilamaia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nesaraLingarajaiah! Thank you so much for participating in the tutorial and for contributing to ScanAPI. I’ve suggested a small change for your review.

Comment thread CONTRIBUTING.md

Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every contribution, big or small, makes a difference. This guide will help you get started with contributing to ScanAPI.

## 0. Table of Content (TOC)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor suggestion to follow the pattern we are using for the docs:

Suggested change
## 0. Table of Content (TOC)
## Contents

@camilamaia camilamaia changed the title completing the issue Add Table of Contents (TOC) to CONTRIBUTING.md #882 docs: complete the issue Add Table of Contents (TOC) to CONTRIBUTING.md #882 Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First Contribution First contribution to the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Table of Contents (TOC) to CONTRIBUTING.md

2 participants