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

Update/contributors #242

Merged
merged 3 commits into from Jul 1, 2020
Merged

Update/contributors #242

merged 3 commits into from Jul 1, 2020

Conversation

@vsoch
Copy link
Member

vsoch commented Jul 1, 2020

Hey @USRSE/usrse-maintainers ! For some reason sourcecred (what we use to generate our contributors graphic) has become unreliable - and so because the tool is not widely used I'm replacing it with the much more widely used all-contributors. You can see a quick preview of the (more interactive) generated content in the README here. You can even tweak the kind of contributions (from doc to code to infra, there is a whole list!) https://allcontributors.org/docs/en/emoji-key

For automation we have a few options. We can install the bot to interact with it in comments, or I can generate a similar automated job to update the graphic once a month, like we were doing before. I can add this for a second PR, whatever the choice be! Probably after that people might want to tweak the emoji / types for their contributions too

vsoch added 2 commits Jul 1, 2020
…be reliable

Signed-off-by: vsoch <vsochat@stanford.edu>
Signed-off-by: vsoch <vsochat@stanford.edu>
@danielskatz
Copy link
Collaborator

danielskatz commented Jul 1, 2020

This idea seems good to me.

Is there a preview for the new version of the content?

Re updating, could we do both? Install the bot, and have an automated job that calls the bot (which could also be called manually if needed)?

@cosden
Copy link
Member

cosden commented Jul 1, 2020

I agree, seems like a good idea. My only real aesthetic concern is that the graphics seem to take up a lot more space. The top of the readme is important real estate for someone new.
@danielskatz, it's here: https://github.com/USRSE/usrse.github.io/tree/update/contributors

@danielskatz
Copy link
Collaborator

danielskatz commented Jul 1, 2020

Yes, let's move contributors to the bottom of the README

Signed-off-by: vsoch <vsochat@stanford.edu>
@vsoch
Copy link
Member Author

vsoch commented Jul 1, 2020

okay, we're moved to the bottom! Does someone here with admin to the organization / repo want to install the bot? As for the automation, I'm going to test a few recipes on some of the singularity hub repos and I'll come back when I have one that I like. And once we install the bot, it might be fun to open a test issue and learn together how to interact with it (I haven't used it before!)

@vsoch
Copy link
Member Author

vsoch commented Jul 1, 2020

@danielskatz @cosden just a note on the bot - he requires write access to the repo (and this makes sense in retrospect) so I would consider adding him carefully.

@cosden
Copy link
Member

cosden commented Jul 1, 2020

This looks much better at the bottom!

I'm good with no bot, and just a monthly automated job to update.

However, how would specific types of contributions be decided? Do we put them in ourselves in .all-contributorsrc?

@vsoch
Copy link
Member Author

vsoch commented Jul 1, 2020

Yeah, you can just check out the types https://allcontributors.org/docs/en/emoji-key and then manually change the tags. That's fairly easy to do in a text editor. I just made them all consistent for code here.

@vsoch
Copy link
Member Author

vsoch commented Jul 1, 2020

Ready for merge?

@danielskatz
Copy link
Collaborator

danielskatz commented Jul 1, 2020

Let's try it!

@vsoch vsoch merged commit 5e3fb74 into master Jul 1, 2020
2 checks passed
2 checks passed
urlcheck
Details
ci/circleci: build-site Your tests passed on CircleCI!
Details
@vsoch vsoch deleted the update/contributors branch Jul 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.