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

docs(README): Adds composite image of contributors to README.md #98

Merged
merged 1 commit into from
Oct 1, 2019

Conversation

mttrbrts
Copy link
Member

@mttrbrts mttrbrts commented Oct 1, 2019

Changes

  • Adds scripts/get_contributors.sh which uses the GitHub API to list all contributors for all AP repositories
  • Adds a static composite image of the output of this script to the contributors section of the README.md

Flags

  • This script needs to be run manually to recreate the Markdown output, this markdown then needs to be rendered as a PNG before it can be used in this repo. Perhaps we could automate this in the future.

Signed-off-by: Matt Roberts <code@rbrts.uk>
@mttrbrts mttrbrts self-assigned this Oct 1, 2019
@irmerk
Copy link
Member

irmerk commented Oct 1, 2019

The automation could be another separate opened issue.

@irmerk
Copy link
Member

irmerk commented Oct 1, 2019

Curious how this works manually. Running this manually, this creates the image, and will need to be pushed to replace the previous image?

@mttrbrts
Copy link
Member Author

mttrbrts commented Oct 1, 2019

Curious how this works manually. Running this manually, this creates the image, and will need to be pushed to replace the previous image?

Running this manually creates a CONTRIBUTORS.md file. I simply took a screenshot of the rendering of that file.

Copy link
Member

@irmerk irmerk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, looks great to me.

@mttrbrts mttrbrts merged commit 24e800b into master Oct 1, 2019
@mttrbrts mttrbrts deleted the mr-contributors-on-README branch October 1, 2019 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants