Plantilla de README

Misión

Esta sección debe contener una breve descripción (3-5 oraciones) de la misión de su proyecto. El objetivo es indicar en qué planea trabajar y ayudar a los contribuyentes externos a comprender aproximadamente qué tipos de funcionalidades serán probablemente bienvenidas para este proyecto.

Consulte también el capítulo de declaración de misión en Producing Open Source Software.

Primeros Pasos

Esta sección debe contener documentación breve escrita para usuarios principiantes sobre cómo comenzar a usar el proyecto. Se puede vincular a documentación más detallada desde aquí.

Información Adicional

Esta sección puede enumerar cualquiera o todos los siguientes elementos:

• Lista de funcionalidades, casos de uso que el software aborda.

• Información sobre principios de diseño utilizados para resolver compensaciones

• Enlaces a documentación adicional a nivel de usuario

• Respuestas a preguntas frecuentes (FAQ), preferiblemente en un formato que permita vincular preguntas específicas y sus respuestas para una referencia más fácil.

Obtener ayuda

Esta sección debe contener documentación breve sobre cómo obtener ayuda para el proyecto como usuario. Esto podría ser tan simple como dirigir a los usuarios al gestor de tareas si así es como su proyecto desea responder preguntas. También podría apuntar a un canal de chat archivado y consultable, alguna lista de correo archivada consultable, o algún foro de usuarios en línea.

Involucrarse

Esta sección debe incluir información sobre cómo ponerse en contacto con el proyecto:Típicamente contendrá enlaces a canales de comunicación archivados, consultables y vinculables.

Quiénes somos

Este es un buen lugar para dar crédito a los Trusted Committers del proyecto.

También es un buen lugar para incluir información sobre lo que significa ser un Trusted Committer para este proyecto - aunque idealmente todos los proyectos en una organización utilizan la misma definición que solo se vincula desde aquí. La razón para mantener el enlace aquí es para colegas que tienen poca o ninguna experiencia trabajando y contribuyendo a proyectos InnerSource para tener un enlace directo a la información de toda la empresa desde los proyectos tecnológicos que necesitan para su trabajo diario.

Contribuir

Esta sección debe documentar (o vincular a documentación) sobre todo lo que un contribuyente principiante necesita saber para comenzar. Típicamente no se cubrirán todos los temas a continuación. Concéntrese en lo que difiere en su proyecto de la configuración estándar y lo que los contribuyentes anteriores encontraron difícil de entender.

• Encontrar el código fuente.

• Encontrar una lista de issues que su proyecto necesita ayuda - estos pueden ser tanto técnicos como no técnicos. Típicamente los mantendrá en un gestor de tareas accesible para los contribuyentes.

• Enlaces a documentación adicional, por ejemplo, sobre la arquitectura del proyecto, convenciones de codificación generales, convenciones de prueba...

• Para contribuciones técnicas: Realizar cambios, construir el proyecto y probar sus cambios.

• Enviar sus cambios de vuelta al proyecto.

Idealmente también incluye información sobre cómo es el proceso preferido de cambios para el proyecto: ¿Deberían los contribuyentes primero abrir un issue y enviar una propuesta, o son bienvenidos a enviar cambios de inmediato? ¿Qué es importante para usted al revisar contribuciones?

Además, debe describir cualquier valor de diseño que desee seguir en el proyecto. Hacer estos explícitos a menudo ayuda a resolver compensaciones más rápida y fácilmente. Además, ayuda a hacer transparentes los cambios en suposiciones que de otro modo serían implícitas.

Con el tiempo notará que esta sección crece sustancialmente. En ese caso, piense en mover la información a archivos separados, por ejemplo, CONTRIBUTING.md y TESTING.md.