search

executablebooks / github-activity

Simple markdown changelogs for GitHub repositories
https://github-activity.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
49 stars 11 forks source link

Mention our definition of "contribution" in the output #67

Closed choldgraf closed 1 year ago

choldgraf commented 2 years ago

Context

We have a definition of "contributor" that includes discussion, opening ideas, providing reviews, etc. It is defined here:

https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports

However, many people probably assume that "contributors" only means "code", and I think it is healthy for us to:

  1. Be explicit about what we mean by contributing
  2. Explicitly recognize non-code actions as "worthy" of contributor status

Proposal

We should signal-boost our definition of "contributors" somehow. This might be as simple as adding an extra line to the ## Contributors to this release output like:

"The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors."

Another way to resolve this would be to do:

Tasks and updates

No response