Pattern idea: Common metadata format to aid discovery of Inner Source projects
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- github, gitlab
- Domain
- developer-experience, tooling
Research direction
Start by reviewing the proposed YAML fields in this issue and comparing the GrimoireLab projects file and Eclipse Foundation initiative linked under Prior art. Consider the source-control metadata alternative alongside a repository file; done means reaching an agreed format or a clear decision not to define one.
Written by the indexing model from the issue text.
Description
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:
- Dominant language
- HTML
- Stars
- 853
- Forks
- 206
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
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.
More from InnerSourceCommons/InnerSourcePatterns
-
community metrics
InnerSourceCommons/InnerSourcePatterns#935 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#934 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#922 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#921 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#915 · 1 assignee ·
All issues in InnerSourceCommons/InnerSourcePatterns
Similar issues
-
area: harness bug status: needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Human-Agent-Society/reef#625 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
vercel-labs/just-bash#464 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100