Added Table of Contents to CONTRIBUTING.md #1307
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
If anything - better to add prek hook to add TOC automatically like in the "airflow" repo https://github.com/apache/airflow/blob/main/.pre-commit-config.yaml#L42 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added a well-structured Table of Contents at the top of CONTRIBUTING.md to improve navigation and help contributors quickly find relevant sections.
Motivation
While reading the document, I noticed that navigation could be more convenient. Adding a TOC makes the file easier to explore, especially for newcomers, and enhances the overall contributor experience.
Changes
Added a Table of Contents section.
Included internal links to major headings.
Ensured formatting remains consistent with existing documentation.
Notes
This PR addresses Issue #259.
Feedback and suggestions are welcome.