mfaerevaag / wd

:rocket: Jump to custom directories in zsh
MIT License
693 stars 45 forks source link

Idea: Collaborators overview in README #98

Closed mfaerevaag closed 4 years ago

mfaerevaag commented 4 years ago

Is your feature request related to a problem? Please describe. We should give credits to the contributors! As I have given the maintainer role away, this has become even more important, as to reflect who's actually doing the work :1st_place_medal:

Describe the solution you'd like Adding a section to the README headlined with "Contributors" seems to be a common way in the open source community.

Describe alternatives you've considered

Additional context Github has recently introduced the "Contributors" section to the right sidebar of a repo's mainview: image

Perhaps this is sufficient for "Contributors", but it does not reflect who's the maintainers, which are currently @alpha-tango-kilo and @MattLewin . Therefore, maybe the best solution would be to have an overview of the maintainers, and let Github do the overview of the rest?

Comments are welcome!

alpha-tango-kilo commented 4 years ago

I think stating who the maintainers are in the README is a solid idea, I'll add that in at some point.

As for the rest of contributions I think GitHub's built in thing you've highlighted is good, plus like with the release notes for v0.5.0 I gave credits to anyone who contributed to something in the changelog, so I think that's a fair system to credit those lovely people who submit PRs

mfaerevaag commented 4 years ago

Cool! Yeah, really like that release :100: :100:

alpha-tango-kilo commented 4 years ago

Thought it was about time 😎

alpha-tango-kilo commented 4 years ago

Added maintainers section