InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Pattern idea: Common metadata format to aid discovery of Inner Source projects
还没有人认领这个 Issue。
- 主要语言
- HTML
- 星标
- 853
- 派生
- 206
- 平均合并
- 1 天 23 小时
- 30 天内合并 PR
- 2
描述
Following on from a conversation in the ISC Slack, would a metadata file added to Inner Source repos in source control (e.g. inner-source.json or inner-source.yaml) aid discovery of Inner Source repos within an organisation? If so, should we define a common format for this metadata?
Alternatively, should this information be derivable from your SCM tool (GitHub/GitLab/Bitbucket etc.)? This would negate the need to add a file to each inner source repo in your organisation.
One suggested format:
# description should be one paragraph
description: This is where you describe the purpose to your users.
Is this a component library, is this a template project, what
benefit is there to me if I use this library in my own project. You
Could even say something about how the project is versioned here.
# github pages or a conflunce link by default
# could be a readme for the project
documentation: https://github.com/InnerSourceCommons/InnerSourceLearningPath/
# technologies used
technologies: Javascript, React, Graphql, etc..
# comma separated list, name <email> (url)
maintainers: Barney Rubble <brubble@flintstones.net> (http://barnyrubble.tumblr.com/)
Prior art:
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先审查本 issue 中提议的 YAML 字段,并比较 Prior art 下链接的 GrimoireLab projects file 和 Eclipse Foundation initiative。将源代码控制元数据这一替代方案与仓库文件一并考虑;完成的标准是达成一致的格式,或明确决定不定义格式。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github, gitlab
- 领域
- developer-experience, tooling
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100