Modelo de CONTRIBUTING

Tipos de contribuiƧƵes

ForneƧa informaƧƵes sobre que tipos de contribuiƧƵes o seu projeto estĆ” procurando aqui. Por exemplo, isso pode incluir relatĆ³rios de bugs, ajuda para responder perguntas de usuĆ”rios, melhorias na documentaĆ§Ć£o, correƧƵes de bugs e implementaƧƵes de novas funcionalidades.

RelatĆ³rios de Bugs

Adicione informaƧƵes sobre como enviar relatĆ³rios de bugs aqui. Isso deve incluir dicas sobre que tipo de informaƧƵes o projeto precisarĆ” para reproduzir e corrigir problemas. TambĆ©m pode incluir informaƧƵes sobre configuraƧƵes incorretas comuns que parecem ser bugs.

Inclua tambĆ©m informaƧƵes sobre o que os colaboradores podem esperar em termos de tempo para a primeira resposta e o processo apĆ³s isso.

SolicitaƧƵes de features

Adicione informaƧƵes sobre como enviar solicitaƧƵes de features aqui. Inclua tambĆ©m informaƧƵes sobre o que os colaboradores podem esperar em termos de tempo para a primeira resposta e o processo apĆ³s isso.

ContribuiĆ§Ć£o de DocumentaĆ§Ć£o

Inclua informaƧƵes sobre as melhores prĆ”ticas de documentaĆ§Ć£o que o seu projeto segue, bem como como criar documentaĆ§Ć£o, verificaƧƵes a serem executadas e como enviar as alteraƧƵes feitas de volta para o projeto.

ContribuiĆ§Ć£o de CĆ³digo Fonte

Esta seĆ§Ć£o deve conter informaƧƵes sobre

  • Como acessar o cĆ³digo fonte do projeto;

  • Layout geral do projeto;

  • Quaisquer requisitos para o ambiente de desenvolvimento;

  • Diretrizes de formataĆ§Ć£o de cĆ³digo;

  • Como executar o conjunto de testes.

Como se tornar um Colaborador ConfiƔvel

Esta seĆ§Ć£o deve deixar explĆ­cito o processo para se tornar um Colaborador ConfiĆ”vel, caso essa opĆ§Ć£o esteja aberta para os contribuidores.

Como indicar Trusted Committers

Esta seĆ§Ć£o serve como um lembrete para os Trusted Committers existentes e uma explicaĆ§Ć£o para os novos, detalhando como adicionar outras pessoas Ć  equipe anfitriĆ£. Idealmente, essa informaĆ§Ć£o Ć© idĆŖntica para todos os projetos na organizaĆ§Ć£o, para que informaƧƵes centrais possam ser vinculadas a partir daqui.

Last updated