Obrigado por querer contribuir com a organização da Python Sul!
Este documento explica como você pode ajudar, registrar tarefas, propor melhorias e enviar alterações para o repositório.
- Faça um fork deste repositório clicando no botão Fork no canto superior direito do GitHub.
- Clone o seu fork localmente:
- git clone https://github.com/seu-usuario/org.git
- cd python-sul-evento
- Configure o repositório original como upstream:
- git remote add upstream https://github.com/python-sul/python-sul-evento.git
Sempre trabalhe em uma branch separada para cada tarefa ou correção:
- git checkout -b minha-branch-descritiva
Utilize o padrão Conventional Commits sempre que possível.
Exemplos de nomes de branch:
- adicionar-voluntarios-2025
- atualizar-timeline-cfp
- corrigir-link-edicoes-passadas
Edite ou crie arquivos Markdown, por exemplo:
- docs/como-organizar-um-evento.md
- docs/objetivo-da-python-sul.md
- docs/faq.md
- people.md
Boas práticas:
- Adicione informações de forma clara, objetiva e organizada.
- Mantenha links e referências consistentes com edições anteriores.
- Evite duplicar informações; centralize contatos e links sempre que possível.
Use mensagens de commit claras e descritivas.
- git add .
- git commit -m "Adiciona voluntários da edição 2025"
- Atualiza cronograma CfP 2025
- Corrige link para site da edição 2024
- Adiciona novas seções sobre identidade visual
Envie sua branch para o seu fork no GitHub:
- git push origin minha-branch-descritiva
- Vá para o seu fork no GitHub.
- Clique em Compare & pull request.
- Descreva brevemente o que você fez e o motivo.
- Marque pessoas da equipe como revisores, se necessário.
- Envie o PR.
- Use issues para sugerir melhorias, reportar erros ou registrar novas ideias.
- Sempre que possível, seja descritivo e adicione exemplos ou links de referência.
- Vincule a issue ao PR, caso ele esteja relacionado.
👉 Assim, conseguimos manter o repositório organizado e facilitar a colaboração de todos!