Skip to content

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

@Dieterbe

Description

@Dieterbe

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions