Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributor Generation #264

Open
jolanglinais opened this issue Dec 20, 2019 · 2 comments
Open

Contributor Generation #264

jolanglinais opened this issue Dec 20, 2019 · 2 comments

Comments

@jolanglinais
Copy link
Member

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.

@mttrbrts is this accurate? @jeromesimeon thoughts?

@jolanglinais
Copy link
Member Author

Related PR: #162
Related Issue: #100

@jeromesimeon
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants