InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Pattern idea: Common metadata format to aid discovery of Inner Source projects
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- HTML
- Estrellas
- 853
- Forks
- 206
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 2
Descripción
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:
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
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.
Evaluación
- Stack tecnológico
- github, gitlab
- Área
- developer-experience, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100