Pattern idea: Common metadata format to aid discovery of Inner Source projects

Abierto

#117 abierto el 27/9/2019 9 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 5/5
Tiempo estimado: Más de una semana
Aptitud para principiantes: 25/100

Tipo de issue: Nueva funcionalidad
Claridad: Necesita aclaración
Estado de actividad: Estancado
Stack tecnológico: github, gitlab
Área: developer-experience, tooling

Línea de trabajo

Empieza revisando los campos YAML propuestos en este issue y comparando el GrimoireLab projects file y la Eclipse Foundation initiative enlazados en Prior art. Considera la alternativa de los metadatos de control de código fuente junto con un archivo del repositorio; se considera terminado cuando se alcance un formato acordado o una decisión clara de no definir uno.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

:book: Type - Content Work

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: