Imageomics / Imageomics/pybioclip

Add section acknowledging contributors

Open
#157 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted question
Dominant language
Python
Stars
67
Forks
14
PR merge metrics
No merged PRs in 30d

Description

As this project has grown, we've seen an increase in outside contributors, and we'd like to acknowledge them appropriately in the README. Thoughts include adding a section like this, for which there appears to be a package to do this automatically. Other input on a nice way to do so would be greatly appreciated :)

Contributor guide

No contributing guide indexed for this repository

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 reading the README and reviewing the linked contributors example and all-contributors package. Decide on an appropriate acknowledgement format for this project, then update the README so outside contributors are clearly recognized; the work is done when the section is present and the chosen approach is documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.