📝 Descrição / Objetivo
Esta tarefa teve como objetivo adequar o projeto aos padrões de software livre (Open Source), garantindo que ele seja transparente, acolhedor para novos contribuidores e legalmente seguro para uso e distribuição. A implementação dos “Community Standards” é fundamental para a saúde e o crescimento do projeto a longo prazo.
✅ Tarefas Realizadas
Para atender ao objetivo, foram criados e configurados os seguintes documentos e padrões no repositório:
📖 Criação do Guia de Contribuição (CONTRIBUTING.md):
- Foi elaborado um guia detalhado para potenciais contribuidores, explicando como reportar bugs, sugerir funcionalidades e submeter contribuições.
🤝 Implementação do Código de Conduta (CODE_OF_CONDUCT.md):
- Foi adicionado um código de conduta para estabelecer as normas da comunidade, promovendo um ambiente colaborativo, inclusivo e respeitoso.
🛡️ Definição da Política de Segurança (SECURITY.md):
- Foi criado um arquivo
SECURITY.mdque instrui os usuários e desenvolvedores sobre como relatar vulnerabilidades de segurança de forma privada e responsável.
- Foi criado um arquivo
📝 Criação de Template de Pull Request (PULL_REQUEST_TEMPLATE.md):
- Foi implementado um template padrão para Pull Requests (geralmente no diretório
.github/). Isso garante que as contribuições sejam bem documentadas e sigam um formato consistente, facilitando as revisões.
- Foi implementado um template padrão para Pull Requests (geralmente no diretório
📑 Melhoria do README.md:
- O arquivo
README.mdfoi atualizado para incluir informações essenciais sobre o projeto e links para a nova documentação.
- O arquivo
📌 Critérios de Aceitação
- O arquivo
LICENSEestá presente na raiz do repositório. - O arquivo
CONTRIBUTING.mdfoi criado e contém as diretrizes para contribuição. - O arquivo
CODE_OF_CONDUCT.mdfoi adicionado e está acessível. - O arquivo
SECURITY.mdfoi criado com as diretrizes de segurança. - O template de Pull Request foi adicionado e é carregado automaticamente ao abrir um novo PR.
- O
README.mdfoi atualizado para refletir o status atual do projeto e guiar os usuários para os demais documentos.