INCATools / INCATools/ontology-development-kit

Add an .all-contributorsrc to template (and to this repo)

Open
#630 1 comment 1 reaction 0 assignees View on GitHub
needs volunteer
Dominant language
Dockerfile
Stars
375
Forks
69
Avg merge
3d 5h
Merged PRs (30d)
7

Description

https://allcontributors.org/

_This is a specification for recognizing contributors to an open-source project in a way that rewards every contribution, not just code._

_The basic idea is this:_

_Use the project README (or another prominent public documentation page in the project) to recognize the contributions of members of the project community._

This seems pretty easy - we would just add a json file to the root of the template like this one:

https://github.com/all-contributors/all-contributors/blob/master/.all-contributorsrc

Note this wouldn't be maintained by hand - it can be done by a bot:

https://allcontributors.org/docs/en/tooling

There is also a CLI tool. We could also add simple python scripts to ODK to sync the contents of ontology headers with the json

I haven't researched this much further. Some questions:

- could we enrich the json
- use https://obofoundry.org/ontology/cro as the role ontology, in addition to [theirs](https://allcontributors.org/docs/en/emoji-key)
- add additional properties from PROV - e.g when the contribution activity started and ended
- use orcids in addition to or in place of github handles

Contributor guide

Open the contributing guide

Research direction

Start with the linked all-contributors .all-contributorsrc example and tooling documentation, then inspect the template root and README. Determine whether CRO roles, PROV dates, and ORCIDs are in scope, along with the proposed bot, CLI, or Python maintenance path. Done means the repository and template have an agreed contributor configuration and maintenance approach.

Written by the indexing model from the issue text.

Assessment

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.