zarr-python icon indicating copy to clipboard operation
zarr-python copied to clipboard

Managing Authors/Contributors with Rever

Open GbotemiB opened this issue 3 years ago • 1 comments
trafficstars

This PR contains setup with rever to manage authors and contributors. @joshmoore and @MSanKeys963

To use rever to manage contributors. authors activity has been configured in rever.xsh to track contributors.

run rever setup in root directory. This will create a AUTHORS file containing the names of all contributors, .mailmap file that contains the name of contributors mapped to their mail and .authors.yml file containing metadata about authors contribution.

TODO:

  • [ ] Add unit tests and/or doctests in docstrings
  • [ ] Add docstrings and API docs for any new/modified user-facing classes and functions
  • [ ] New/modified features documented in docs/tutorial.rst
  • [ ] Changes documented in docs/release.rst
  • [ ] GitHub Actions have all passed
  • [ ] Test coverage is 100% (Codecov passes)

GbotemiB avatar Oct 13 '22 22:10 GbotemiB

Why not use the all contributors bot? Remember, contributions to a project are not always in the form of commits, and we should be acknowledging all types of contributions. Also, this adds additional files to the root Zarr repository which looks redundant at first glance.

Hi @Saransh-cpp, thanks for the tip. Actually the goal is to use rever to automate releases. While automating releases, it could handle contributors list too. I will check to see if it acknowledges all types of contributions.

Regarding the files, we could reduce the number of files.

GbotemiB avatar Oct 17 '22 09:10 GbotemiB

This has unfortunately gone stale. Will it be revived or should we close this?

jhamman avatar Dec 07 '23 21:12 jhamman

Closing this out as stale. Feel free to reopen if there is interest in picking this up.

jhamman avatar Feb 13 '24 22:02 jhamman