Automate updating author list in `CITATION.cff`

未关闭
#411 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
github, python
领域
tooling

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

enhancement

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.
主要语言
Python
星标
62
派生
10
平均合并
7 天 6 小时
30 天内合并 PR
6

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

UCL-ARC/python-tooling 的其他 Issue

查看 UCL-ARC/python-tooling 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。