InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Acknowledging all contributions/contributors

Open
#543 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

:gear: Type - Meta
Dominant language
HTML
Stars
853
Forks
206
Avg merge
1d 23h
Merged PRs (30d)
2

Description

GitHub has a way to show the people that committed (code) to this project. However by default only very few people are shown, and there is no further information about what they have contributed either.

Screenshot 2023-06-04 at 12 37 25

As our community grows, it would be great to acknowledge the broad range of people that are supporting our patterns in all sorts of ways, not just the ones contributing code/patterns.

Implementation thoughts

I have heard good things about the all-contributors spec and bot but I don't know how it works in practice.

Their claim is:

Recognize All Contributors - Including those that don't push code

However their documentation looks like users need a GitHub handle to be added as contributors, which seems counter intuitive.

I am taking inspiration from The Turing Way project, who are using the tool for years.
We could review their implementation notes. Some links to get started:

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

Read the linked Turing Way contributors.md and CONTRIBUTING.md sections, then review the all-contributors specification and bot documentation. Determine how this project should represent code and non-code contributions, including contributors without GitHub handles. Done means the chosen recognition approach and its maintenance process are agreed and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
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.