USRSE / USRSE/usrse.github.io

Should we use the all-contributors bot on this site?

Open
#1,380 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
33
Forks
104
Avg merge
12h 3m
Merged PRs (30d)
10

Description

Some OSS communities I'm part of use all-contributors to recognize contributions, esp those that are not necessarily code -- like website content 🙂

What do we think about doing that?

It just occurred to me while doing a review on a PR and pinging someone else to ask them if they want to review as well.
At pyOpenSci for example, we review content and then all the reviewers are added as contributors.
See for example this review of one of the sections in one of our guides:
https://github.com/pyOpenSci/python-package-guide/pull/106#issuecomment-1847793410

I could imagine a similar review process for us: e.g. when @rinkug et al release the guide they've been putting so much work into, then a wider part of the community could review a PR adding it to this site. This not only gives everyone credit but also would help show visitors to our site the breadth of our community

It would require (1) giving the bot permissions and then (2) educating site maintainers about how the bot works.
See https://allcontributors.org/docs/en/bot/overview

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the all-contributors bot overview linked in the issue and the example pyOpenSci pull request. Determine whether this site wants the bot, what permissions it would require, and how maintainers would be taught to use it; done means a documented decision and implementation plan.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.