Prototipo README

Misión

Esta sección debe conter unha descrición breve (de entre tres e cinco liñas) na que se describe a misión do seu proxecto. O obxectivo é indicar en que planea traballar e axudar os/as contribuidores/as externos/as a comprender que tipos de funcionalidades serán benvidas neste proxecto.

Véxase tamén o capítulo de definición da misión en produción de software libre.

Comezo

Esta sección debe conter documentación breve escrita para os/as novos/as usuarios/as, sobre como comezar a usar o proxecto. Pódese vincular documentación máis detallada desde aquí.

Máis información

Esta sección pode enumerar calquera ou cada un dos seguintes aspectos:

• Unha listaxe de funcionalidades, casos de uso que aborda o software.

• Información sobre os principios de deseño que se utilizan para resolver as contradicións.

• Ligazóns á documentación adicional a nivel de usuario/a.

• Respostas a preguntas frecuentes (FAQ), preferiblemente nun formato que permita vincular preguntas específicas máis as súas respostas para facilitar a súa consulta.

Axuda

Esta sección debe conter unha breve documentación sobre a maneira de obter axuda para o proxecto como persoa usuario/a. Isto podería ser tan simple como dirixir ás persoas aos/ás usuarios/as ao sistema de seguimento de incidencias se así é como lle gustaría responder as preguntas relativas ao proxecto. Tamén podería indicar unha canle de chat arquivada na que se poidan realizar buscas, algunha listaxe de correo arquivada na que se poidan realizar buscas ou algún foro de usuarios/as en liña.

Familiarización

Esta sección debe incluír información breve sobre como entrar en contacto co proxecto; polo xeral, este apartado contén as ligazóns ás canles de comunicación arquivadas e de busca.

Quen somos

Este é un bo lugar para dar crédito aos/ás trusted committers do proxecto.

Tamén é a sección na que incluír información sobre o que significa ser un/unha trusted committer no proxecto, aínda que o ideal é que todos os proxectos dunha organización empreguen a mesma definición, á cal pode acceder só mediante unha ligazón neste apartado. A razón de poñer aquí a ligazón é que, deste xeito, os/as compañeiros/as que teñen pouca ou ningunha experiencia traballando ou contribuíndo en proxectos InnerSource contan cunha canle directa á información dos proxectos tecnolóxicos da empresa que precisan para o seu traballo diario.

Contribucións

Nesta sección debe documentar (ou incluír unha ligazón á documentación) aqueles aspectos que calquera novo/a contribuidor/a precisa saber para comezar. Polo xeral, non se cubrirán todos os temas seguintes. Céntrese naquilo que difire no seu proxecto respecto da configuración estándar, así como naquilo que lles resultou difícil de entender aos/ás contribuidores/as anteriores.

• Atopar o código fonte.

• Atopar unha listaxe de incidencias coas que o seu proxecto precisa axuda que pode ser técnica ou non. Polo xeral, os/as contribuidores/as poden acceder a través dun sistema de seguimento de incidencias.

• Ligazóns á documentación adicional, por exemplo, sobre a arquitectura do proxecto, convencións xerais de codificación, convencións de proba...

• Para contribucións técnicas: Facer cambios, construír o proxecto e probar os cambios.

• Enviar os cambios ao proxecto.

Tamén incluirá información sobre como é o proceso preferente para os cambios no proxecto: os/as contribuidores/as deberían primeiro abrir unha incidencia e enviar unha proposta, ou son benvidos/as a enviar os cambios directamente? Que é importante para vostede á hora de revisar as contribucións?

Ademais, debe describir os valores de deseño que desexa seguir no proxecto. Facelos explícitos adoita axudar a resolver as contradicións con maior rapidez e facilidade. Ademais, axuda a facer transparentes os cambios en supostos, que doutro xeito, estarían implícitos.

Co tempo notará que esta sección crece substancialmente. Nese caso, pense en trasladar a información a arquivos separados, por exemplo, a CONTRIBUTING.md e TESTING.md.