Prototipo CONTRIBUTING

Tipos de contribucións

Nesta sección proporcione información sobre o tipo de contribucións que está a procurar o seu proxecto. Por exemplo, poden ser informes de erros, axuda para responder preguntas dos/das usuarios/as, melloras da documentación, corrixir erros e a posta en marcha de funcionalidades.

Informes de erros

Engada información sobre como enviar informes de erros neste apartado. Isto debe incluír suxestións sobre o tipo de información que precisará o proxecto para reproducir e solucionar problemas. Tamén pode incluír información sobre os erros de configuración máis comúns que parecen bugs.

Ademais, deberá incluír información sobre o que os/as contribuidores/as poden esperar en termos do tempo que transcorre dende a primeira resposta e o proceso posterior.

Peticións de funcionalidades

Engada información sobre como enviar feature requests. Do mesmo xeito, tamén debería incluír neste apartado a información sobre o que cabe esperar por parte dos/das contribuidores/as, en termos do tempo da primeira resposta e do proceso posterior.

Contribucións de documentación

Inclúa información sobre as mellores prácticas de documentación que segue o seu proxecto, así como instrucións sobre como crear a documentación, a execución de verificacións e o envío de cambios realizados no proxecto.

Contribucións de código fonte

Esta sección debería conter información sobre:

• Como acceder ao código fonte do proxecto.

• Disposición xeral do proxecto.

• Calquera requisito para o medio de desenvolvemento.

• Directrices de formato de código.

• Como executar o conxunto de probas.

Como chegar a ser trusted committer

Esta sección debe facer explícito o proceso para converterse nun/nunha trusted committer se esa ruta está aberta aos/ás contribuidores/as.

Como nomear o/a trusted committer

Esta sección serve a modo de recordatorio para os/as trusted committers existentes e como explicación para os/as novos/as. Nela detállase como engadir a outras persoas ao host team. Deste xeito, o ideal é que esta información sexa idéntica para tódolos proxectos da organización, de modo que a información máis relevante se poida vincular desde aquí.