You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documenting the process for compiling a list of contributors in the README file:
1. seed_contributors.sh
The README in techdocs currently relies on seed_contributors.sh. This gets all contributors to a specific repo, in this case techdocs, and runs them through the all-contributors-cli to generate a comprehensive markdown if an icon with a link per user.
2. get_contributors.sh
This pulls all contributors from all repos from an organization, but only puts their profile image into a markdown file as an image and nothing more. There is no display or information on who that user is.
I think 1 is a better option, because it is more comprehensive. Also, it only needs to be run the first time to initialize. There may be the need for a command to refresh it, but it will be a minimal command that we could include in a build script maybe.
My personal feeling on this is that what Git says are contributors is still the most reliable list, and I'm unclear that having those in the README is all that useful.
Documenting the process for compiling a list of contributors in the
README
file:1.
seed_contributors.sh
The
README
intechdocs
currently relies onseed_contributors.sh
. This gets all contributors to a specific repo, in this casetechdocs
, and runs them through theall-contributors-cli
to generate a comprehensive markdown if an icon with a link per user.2.
get_contributors.sh
This pulls all contributors from all repos from an organization, but only puts their profile image into a markdown file as an image and nothing more. There is no display or information on who that user is.
I think
1
is a better option, because it is more comprehensive. Also, it only needs to be run the first time to initialize. There may be the need for a command to refresh it, but it will be a minimal command that we could include in a build script maybe.@mttrbrts is this accurate? @jeromesimeon thoughts?
The text was updated successfully, but these errors were encountered: