Add manifest.contributors config option
#5322
Conversation
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| - `email`: the contributor's email address | ||
| - `github`: the contributor's GitHub URL | ||
| - `contribution`: list of contributions, can be any of `'author'`, `'maintainer'` | ||
| - `orcid`: the contributor's [ORCID](https://orcid.org/) |
There was a problem hiding this comment.
| - `orcid`: the contributor's [ORCID](https://orcid.org/) | |
| - `orcid`: the contributor's [ORCID](https://orcid.org/) URL |
| - `affiliation`: the contributor's affiliated organization | ||
| - `email`: the contributor's email address | ||
| - `github`: the contributor's GitHub URL | ||
| - `contribution`: list of contributions, can be any of `'author'`, `'maintainer'` |
There was a problem hiding this comment.
List of contributions? Or type of contribution? It has to be a string, so people have to choose right?
There was a problem hiding this comment.
Ah no it can be multiple, nice 👍🏻
| - `contribution`: list of contributions, can be any of `'author'`, `'maintainer'` | |
| - `contribution`: list of contribution types, can include any of `'author'`, `'maintainer'` |
There was a problem hiding this comment.
ok, so it can be 'author', 'maintainer', or ['author', 'maintainer'].
There was a problem hiding this comment.
Yeah, always a list though. So ['author']
There was a problem hiding this comment.
Or contribution roles?
As actually I personally would have three roles: author (original person who started), maintainer (someone who is currently leading the development) and a contributor (someone who occasionally/regularly throws things in)
There was a problem hiding this comment.
I like @jfy133 's thinking, though maybe contributor is harder to map to Ben's ontology.
There was a problem hiding this comment.
I'm not super opinionated about the contribution types, as long as it doesn't cause problems with supporting things like BCO
"author" and "maintainer" seem to map to "authoredBy" and "curatedBy". if we add "contributor", I could just map that also to "curatedBy" in the BCO. that's not the end of the world, but it would minimize the contribution of "maintainers"
also, I wonder if it's necessary to include small contributors in the manifest when you could just credit them in the README
There was a problem hiding this comment.
By occasionally/regularly I didn't necessarily mean small, but rather a person who is not 'running' or 'leading' the point of view.
For example, I currently do most of the day to do managing of bug reports and fixes, user support, and project planning, in nf-core/mag (maintainer), but then I often have @prototaxites helping with reviews and every month or so dropping a chunky bit of new functionality (contributor).
To map to an analogy from academic publishing: the maintainer is the first author (at the given time point), but then a contributor is someone who has still done a good chunk of work worthy of co-authorship in the middle of the list. Versus someone who made a couple of small fixes or docs improvements who would not go into acknowledgements (which here would go into the README).
I think that still maps to the ontology with 'curatedBy' 👍, what I'm proposing is more of a human interpretation thing to make sure the level of acknowledgement of peoples input is fair
There was a problem hiding this comment.
in that case I would be fine with adding "contributor" and mapping it also to "curatedBy" in the BCO. the kind of contributions you mentioned are comparable to that of a maintainer IMO
| - `affiliation`: the contributor's affiliated organization | ||
| - `email`: the contributor's email address | ||
| - `github`: the contributor's GitHub URL | ||
| - `contribution`: list of contributions, can be any of `'author'`, `'maintainer'` |
There was a problem hiding this comment.
I like @jfy133 's thinking, though maybe contributor is harder to map to Ben's ontology.
Close #4034
Deprecate
manifest.author, removemanifest.maintainerfrom #5314 , and addmanifest.contributorswhich is a list of maps. The maps are converted to records under the hood.Contribution types include "author" and "maintainer". The BCO spec is based on PAV ontology which includes "createdBy", "authoredBy", and "curatedBy". I think we can map author -> authoredBy and maintainer -> curatedBy. Not sure that we need a "creator" option separate from "author". But this ontology seems to be the standard across multiple provenance formats.