"inline" table of contents and contribution guidelines seems more cleaner #354

New Issue

2025-11-06T15:13:30-06:00

GiteaMirror commented

2025-11-06 15:13:30 -06:00

Originally created by @Dieterbe on GitHub (Aug 23, 2025).

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). 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.

GiteaMirror commented

2025-11-06 15:13:31 -06:00

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

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

@vivekkumar2003648-bit commented on GitHub (Aug 26, 2025): Heelo dear, I am a new creator Please give me a normal project

GiteaMirror commented

2025-11-06 15:13:31 -06:00

@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!

@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!

GiteaMirror commented

2025-11-06 15:13:31 -06:00

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

هلا

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