Skip to content

Criar arquivo CONTRIBUTING.md: consolidar boas práticas e melhor introduzir o projeto para novas pessoas contribuidoras #187

@PGuardini

Description

@PGuardini

🎯 Contexto e objetivo

No repositório [github.com/cumbucadev/cinemaempoa](https://github.com/cumbucadev/cinemaempoa) existe no arquivo `README.md` um breve trecho onde se comenta sobre contribuições. Ele assume de antemão que a pessoa que quer contribuir tenha algum conhecimento de git e github, indicando que esta vá direto à página de issues do projeto e busque projetos com a marcação `Good first issue`.

⚠️Problema

Não está claro como novas pessoas que queiram contribuir para o projeto devem fazer sua contribuição. Não está sendo mostrado qual a forma padrão para se fazer uma contribuição, nem por onde se deve começar.

✅ Proposta de solução

Criar um arquivo CONTRIBUTING.md para consolidar as boas práticas do projeto e formas para contribuir ao projeto, visando uma melhor introdução ao projeto e à sua futura contribuição.

🗺️ Plano

  1. Fazer levantamento de boas práticas a serem seguidas no projeto;
  2. Criar um arquivo CONTRIBUTING.md;
  3. Consolidar neste arquivo como é possível contribuir para o projeto, por onde começar a contribuir e quais são as boas práticas do projeto.

📈 Impacto esperado

  • Maior clareza sobre o processo de contribuição (ex.: explicitação de boas práticas)
  • Maior receptividade e melhor introdução de pessoas contribuidoras

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions