Skip to content

Canonicalize contributor list #1416

Closed

Description

@ammario

CONTRIBUTORS.md is standard and the README will get bloated very quickly with our current approach.

I'm not sure why #1144 was created.

cc @mafredri

Activity

  1. ammario commented on May 13, 2022

    @ammario
    MemberAuthor

    Actually, I propose we delete the contributor list. It's built into GitHub already.

    image

  2. mafredri commented on May 13, 2022

    @mafredri
    Member

    It was one of my onboarding tasks (#1112). There was discussion among the team replace it with something like all-contributors instead.

    I'd be in favor of just relying on the builtin GitHub Contributors, but unfortunately it only picks up commits to main, so we can't give thanks to people who've contributed in other ways. For example issue triage or assists/reviews on PRs.

    Whatever form it may take, it would be nice to keep the contributors in the readme for as long as feasible to make it more prominent/show our appreciation. We may have to move it to a separate file at some point, but that would feel a bit like hiding it.

  3. ammario commented on May 13, 2022

    @ammario
    MemberAuthor

    I disagree on the basis it is non-standard, unlikely to be up to date, and bloats the README.

  4. self-assigned this
    on May 16, 2022
  5. kylecarbs commented on May 16, 2022

    @kylecarbs
    Member

    @AbhineetJain thoughts on the discussion here? Seems like we could just remove it!

  6. AbhineetJain commented on May 16, 2022

    @AbhineetJain
    Contributor

    @kylecarbs I interpreted the discussion as removing the list from the README, and instead maintaining the standard CONTRIBUTORS.md.

  7. AbhineetJain commented on May 16, 2022

    @AbhineetJain
    Contributor

    I agree though, that it is unlikely to be up-to-date in the long run.

  8. Emyrk commented on May 16, 2022

    @Emyrk
    Member

    Is there any bots we can use to maintain it?

  9. AbhineetJain commented on May 16, 2022

    @AbhineetJain
    Contributor

    As @mafredri mentioned above, there is all-contributors.

  10. ammario commented on May 18, 2022

    @ammario
    MemberAuthor

    👍 to automating it with an existing bot and using a separate file. Let's make the README as clean as a temple.

  11. im-coder-lg commented on May 19, 2022

    @im-coder-lg
    Contributor

    I don't think this is my place(my suggestion though), but why not add the contributors list as a mini-table, like an Excel sheet? Less space, more contributors, and maybe also enclose it with a collapsible section, if it seems to take more screen space.

  12. added this to the Community MVP milestone on May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

apiArea: HTTP API

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions