UCL-ARC / UCL-ARC/python-tooling
Automate updating author list in `CITATION.cff`
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 62
- Forks
- 10
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 6
Description
As we have contributor information recorded in machine readable format in both .all-contributorsrc and CITATION.cff it would be nice if we could automatically update latter based on the former? Main problems I can see are:
- That it would be difficult to get affiliations automatically (short of doing something like checking if GitHub user is part of UCL organization?)
- I'm not sure its currently possible to get ORCID for a user using GitHub REST API if they have it linked to their profile.
- GitHub profile only lists name as one field, not separated in to given and family name components.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the contributor data in .all-contributorsrc and CITATION.cff, then investigate whether the GitHub REST API exposes the ORCID, affiliation, and name components needed for the update. Done would require a defined mapping and an agreed approach for fields that cannot be retrieved automatically.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100