Regras de Colaboração
Regras de comunicação¶
Comunique-se com sua equipe: Antes de começar a contribuir, certifique-se de que está alinhado com a equipe sobre os objetivos, tarefas e ferramentas de colaboração. Isso pode ajudar a evitar conflitos e garantir que todos estejam trabalhando na mesma direção.
Issues¶
Use o sistema de gerenciamento de problemas (Issues): Use o Issues para relatar bugs, solicitar recursos ou discutir ideias com sua equipe. Certifique-se de fornecer informações claras e precisas para ajudar a equipe a entender o problema e encontrar uma solução.
Fork¶
Faça fork do repositório (Para pessoas que não são admins): Se você não tiver permissão para fazer alterações diretas no repositório, faça um fork do repositório e crie um clone do seu fork no seu computador. Você pode trabalhar em seu próprio fork e fazer pull requests para a branch principal para contribuir com suas alterações.
Regras de Branch¶
Trabalhe em uma branch separada com o nome e número da Issue: Se você tiver permissão para fazer alterações diretas no repositório, certifique-se de trabalhar em uma branch separada (não na branch principal). Isso permite que você faça alterações sem afetar o trabalho de outros membros da equipe e evita conflitos.
Exemplo de branch:
1-criacao-de-documento
Regras de Commit¶
Faça commits com mensagens claras: Ao fazer commits no repositório, use mensagens claras e descritivas para descrever as alterações que você fez. Isso ajuda a equipe a entender o que foi alterado e por quê.
Lembre-se de começar os commits com alguns prefixos
docs
- Mudanças de documentação, seja criação, edição ou deleção.
fix
- Correção de algum bug.
style
- Mudanças em quaisquer estilização.
feat
- Uma nova funcionalidade
Exemplo:
docs: Criação da elicitação de requisitos
Revisão de Código¶
Revise o código de outros membros da equipe: Seja um revisor ativo do código de outros membros da equipe. Isso pode ajudar a identificar problemas de lógica ou erros de sintaxe, bem como melhorar a qualidade geral do código e documentação.
Normas de Conduta¶
Seja um bom colaborador: Certifique-se de seguir as normas de colaboração da equipe e ser respeitoso com seus colegas de equipe. A colaboração é fundamental para o sucesso de qualquer projeto em grupo, então faça sua parte para tornar o processo o mais suave possível.
Histórico de versão¶
Data | Versão | Descrição | Autor(es) | Revisor |
---|---|---|---|---|
23.04.2023 | 1.0 | Criação do documento de Colaboração | Matheus | Diógenes |
25.04.2023 | 1.1 | Edição do documento, adição do título Normas de Conduta | Diógenes | Matheus |