[GH-ISSUE #3606] "inline" table of contents and contribution guidelines seems more cleaner #8471

Open
opened 2026-04-19 03:19:53 -05:00 by GiteaMirror · 8 comments
Owner

Originally created by @Dieterbe on GitHub (Aug 23, 2025).
Original GitHub issue: https://github.com/sindresorhus/awesome/issues/3606

Hello!
I'm working on awesome list for fitness & health related free/open source projects
https://github.com/Dieterbe/awesome-health-fitness-oss

I have some questions about the style guidelines.
Note how at the top of the readme i have an introduction, wherein i explain the 3 types of lists with which types of projects go in there (which implies most of what contributors should know) along with a basic request for contributions.

I know the "awesome instructions" call for a separate contribution guideline document, and a separate table of contents, but in this case, it seems that all these blend nicely together into one place. and following the instructions to the letter (pulling this section apart) would cause redundancy.

So in this case wouldn't it make more sense to keep it simple and elegant?
Also, what do you think of my approach to:

  • also have a separate list for "interesting" (but not quite "awesome")? (the instructions call for this to go into a separate file but that seems a bit uglier to me, having it all in one file allows for easier searching)
  • use a table wherein i can put various "attributes"

Curious for any feedback,
thanks.

Originally created by @Dieterbe on GitHub (Aug 23, 2025). Original GitHub issue: https://github.com/sindresorhus/awesome/issues/3606 Hello! I'm working on awesome list for fitness & health related free/open source projects https://github.com/Dieterbe/awesome-health-fitness-oss I have some questions about the style guidelines. Note how at the top of the readme i have an introduction, wherein i explain the 3 types of lists with which types of projects go in there (which implies most of what contributors should know) along with a basic request for contributions. I know the "awesome instructions" call for a separate contribution guideline document, and a separate table of contents, but in this case, it seems that all these blend nicely together into one place. and following the instructions to the letter (pulling this section apart) would cause redundancy. So in this case wouldn't it make more sense to keep it simple and elegant? Also, what do you think of my approach to: - also have a separate list for "interesting" (but not quite "awesome")? (the instructions call for this to go into a separate file but that seems a bit uglier to me, having it all in one file allows for easier searching) - use a table wherein i can put various "attributes" Curious for any feedback, thanks.
Author
Owner

@vivekkumar2003648-bit commented on GitHub (Aug 26, 2025):

Heelo dear,
I am a new creator
Please give me a normal project

<!-- gh-comment-id:3225875503 --> @vivekkumar2003648-bit commented on GitHub (Aug 26, 2025): Heelo dear, I am a new creator Please give me a normal project
Author
Owner

@Angel-Mathew007 commented on GitHub (Sep 4, 2025):

Hi!
I’m interested in contributing to this project and would like to help with this issue. Could you please provide some guidance on how best to proceed or assign it to me? I’m excited to contribute and learn.

Thank you!

<!-- gh-comment-id:3252618003 --> @Angel-Mathew007 commented on GitHub (Sep 4, 2025): Hi! I’m interested in contributing to this project and would like to help with this issue. Could you please provide some guidance on how best to proceed or assign it to me? I’m excited to contribute and learn. Thank you!
Author
Owner

@awladelking-maker commented on GitHub (Sep 17, 2025):

هلا

<!-- gh-comment-id:3303371576 --> @awladelking-maker commented on GitHub (Sep 17, 2025): هلا
Author
Owner

@shashankalassya-ops commented on GitHub (Dec 10, 2025):

Hello 👋
How can I join this project?
Im interested in this .
Please help me to do this project..
Thank you

<!-- gh-comment-id:3636835421 --> @shashankalassya-ops commented on GitHub (Dec 10, 2025): Hello 👋 How can I join this project? Im interested in this . Please help me to do this project.. Thank you
Author
Owner

@franciscoarturorivera371-cyber commented on GitHub (Dec 10, 2025):

Yes please.
😀😀😀

<!-- gh-comment-id:3638508363 --> @franciscoarturorivera371-cyber commented on GitHub (Dec 10, 2025): Yes please. 😀😀😀
Author
Owner

@Prathikgowda360 commented on GitHub (Mar 7, 2026):

Awesome Health & Fitness OSS

A curated list of free and open-source projects related to health, fitness, and wellness.
This list is meant to help developers, enthusiasts, and practitioners discover useful projects, libraries, and tools in the community.

Types of Projects

This list is organized into three main categories:

  1. Core Awesome Projects – Fully featured and widely useful open-source projects that are actively maintained and demonstrate high quality.
  2. Supporting Tools & Libraries – Helpful tools, libraries, or frameworks that complement the core projects.
  3. Educational Resources – Learning materials, datasets, or reference implementations related to health and fitness.

Note: Projects that don’t fully meet the “awesome” criteria but are still interesting or useful are included under a separate “Interesting Projects” section at the bottom. These are not part of the main curated list, but are worth checking out.

Contributing

Contributions are welcome and encouraged!
If you have a project that fits one of the above categories, please submit a pull request.
When contributing, please:

  • Make sure the project is open source and publicly accessible.
  • Include a short description and relevant attributes (e.g., license, language, platform, tags).
  • Respect the distinction between Awesome Projects and Interesting Projects.

Tip: Use the table format for consistency. This helps readers quickly scan and compare projects.


Happy hacking and staying healthy!

<!-- gh-comment-id:4015895310 --> @Prathikgowda360 commented on GitHub (Mar 7, 2026): # Awesome Health & Fitness OSS A curated list of **free and open-source projects** related to health, fitness, and wellness. This list is meant to help developers, enthusiasts, and practitioners discover useful projects, libraries, and tools in the community. ## Types of Projects This list is organized into three main categories: 1. **Core Awesome Projects** – Fully featured and widely useful open-source projects that are **actively maintained** and demonstrate high quality. 2. **Supporting Tools & Libraries** – Helpful tools, libraries, or frameworks that complement the core projects. 3. **Educational Resources** – Learning materials, datasets, or reference implementations related to health and fitness. > Note: Projects that don’t fully meet the “awesome” criteria but are still **interesting or useful** are included under a separate **“Interesting Projects”** section at the bottom. These are not part of the main curated list, but are worth checking out. ## Contributing Contributions are **welcome and encouraged**! If you have a project that fits one of the above categories, please submit a pull request. When contributing, please: - Make sure the project is **open source and publicly accessible**. - Include a **short description** and relevant **attributes** (e.g., license, language, platform, tags). - Respect the distinction between **Awesome Projects** and **Interesting Projects**. > Tip: Use the table format for consistency. This helps readers quickly scan and compare projects. --- *Happy hacking and staying healthy!*
Author
Owner

@aarnav-great commented on GitHub (Mar 31, 2026):

Hey @Dieterbe I am interested in contributing to your project please give me an easy project I expertise in go python and web development

<!-- gh-comment-id:4162403097 --> @aarnav-great commented on GitHub (Mar 31, 2026): Hey @Dieterbe I am interested in contributing to your project please give me an easy project I expertise in go python and web development
Author
Owner

@gq4yrkcf9j-bit commented on GitHub (Apr 19, 2026):

Bruh

<!-- gh-comment-id:4275275664 --> @gq4yrkcf9j-bit commented on GitHub (Apr 19, 2026): Bruh
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/awesome-sindresorhus#8471