- Semestre 2023.1
1 - Instale o Python na sua máquina;
2 - Instale a biblioteca mkdocs com pip install mkdocs
e o template pip install mkdocs-material
3 - Com o mkdocs instalado, fica disponível os seguintes comandos
mkdocs serve // Inicia o live-reloading server na máquina
mkdocs build // Faz o build da documentação
## para windows é melhor recorrer aos seguintes comandos
python -m mkdocs serve
python -m mkdocs build
## Comando para deploy
mkdocs gh-deploy
python -m mkdocs gh-deploy
1 - 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.
2 - 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.
3 - 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.
4 - 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.
5 - 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ê.
6 - 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.
7 - Documente seu trabalho: Certifique-se de documentar seu trabalho, especialmente se você estiver trabalhando em uma tarefa complexa ou com várias etapas. Isso pode ajudar outros membros da equipe a entender o que você fez e como eles podem construir sobre seu trabalho.
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.
Imagem | Nome | Contato |
---|---|---|
Ana Beatriz | https://github.com/anabfs | |
Brunna Louise Martins | https://github.com/brunna-martins | |
Diogenes Dantas | https://github.com/diogjunior100 | |
Matheus Phillipo | https://github.com/MattSilverio | |
Milena Beatriz | https://github.com/milenaaires | |
Rafael Nobre | https://github.com/RafaelN0bre |