UCL-ARC / UCL-ARC/python-tooling
Automate updating author list in `CITATION.cff`
Ouverte
Personne n'a encore pris cette issue.
enhancement
- Langage dominant
- Python
- Étoiles
- 62
- Forks
- 10
- Merge moyen
- 7 j 6 h
- PR mergées (30 j)
- 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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- github, python
- Domaine
- tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100