cytomining
FeatureRequest: Use CONTRIBUTORS or CITATION.cff file for contributor citation
Feature type
-
[X] Add new functionality
-
[X] Change existing functionality
General description of the proposed functionality
This issue highlights the possibility of using a CONTRIBUTORS or CITATION.cff file (or similar) to help acknowledge those who have made contributions to Pycytominer. Using a file like this may simplify the maintenance of the maintainers or authors fields found within the pyproject.toml or setup.py file. It also would enhance bibliographic capabilities of Pycytominer more generally.
The CITATION.cff file would offer the additional benefits of greater information and structure for contributors. It's also integrated into the GitHub interface, making it simple for someone to cite this repository in their work from the repository sidebar.
Originally mentioned as part of #303 via this discussion.
Feature example
A pyproject.toml file might look like:
authors = [
"Cyto Miner <[email protected]>",
]
maintainers = [
"Cyto Miner <[email protected]>",
]
An example excerpt from a related citation.cff file might look like:
authors:
- given-names: Cyto
family-names: Miner
email: <[email protected]>
orcid: 'https://orcid.org/0000-0000-0000-0000'
Alternative Solutions
No response
Additional information
No response
