adaptdk / contrib
开源贡献日志
2.0.0
2023-11-23 03:19 UTC
Requires
- symfony/console: 6.3.*
- symfony/yaml: 6.3.*
- twig/twig: 3.8.*
This package is auto-updated.
Last update: 2024-09-19 18:11:59 UTC
README
本项目旨在收集有关特定组织的开源贡献信息。
生成输出文件
首先,请确保您已安装了依赖项,例如 composer install
。
HTML
有一些脚本用于根据数据生成一个 HTML
页面。它还包含可能在未来公开页面时有用的 JSON-LD
输出。
您可以尝试以下命令。
./contriblog html > contributions.html
RSS
还有生成 RSS 输出的方法。
您可以尝试以下命令。
./contriblog rss > rss.xml
添加条目
- 使用助手,例如
./contriblog add
,或者 - 手动编辑 YAML 文件,然后使用
./contriblog format
处理它以获取标准输出。
YAML 格式
YAML 文件试图自我解释。它试图从数据可能未来使用的角度来描述贡献。
类型是 CHAOSS 贡献类型。
贡献按日期排序。
您可能想启用 git 预提交钩子,例如使用 git config core.hooksPath .githooks
。
参考
- 社区健康分析开源软件,CHAOSS 提供了关于开源软件数据测量的指导,但它还提供了可用于本项目的通用指导。
- CHAOSS 常见指标工作组(通用 WG) 包含更多直接建议。
致谢
本项目最初由 Adapt 开发。