Checklist¶
📦 Gerência e Controle de Versão¶
- Repositório público no GitHub/GitLab (com histórico limpo e organizado)
- Localizado no salsa: https://salsa.debian.org/debian-brasil-team
- Uso de
git-flow
ou similar para estratégia de branches - Versionamento semântico (SemVer) aplicado
- Tags e releases publicados com Release Notes claras
- GitHub Actions / GitLab CI configurado com:
- Build automatizado
- Testes automatizados (unitários/integrados)
- Linter (ex: ESLint, Flake8, etc.)
- Encontrado em: Contribuindo para o Projeto — Debian Salsa
- Validação de segurança e dependências (ex: Dependabot, Snyk)
- Encontrado em: Políticas de Segurança — Debian Salsa
- Arquivos de configuração de ambiente:
Dockerfile
,docker-compose.yml
,.env.example
📚 Documentação¶
Em vez de manter arquivos .md
diretamente no repositório para a documentação, a comunidade optou por centralizar e apresentar as informações de forma mais completa e organizada em um site.
-
README.md
completo com: - Visão geral do projeto (com prints de como funciona o projeto)
- Encontrado em: Debian Brasil - Quem Somos
- Tecnologias utilizadas
- Ferramentas: Debian Brasil - Sbuild
- Como rodar localmente (instalação + execução)
- Como contribuir (passo a passo)
- Como usar a aplicação (guia de usuário)
- Licença
-
CONTRIBUTING.md
com diretrizes de contribuição - Como colaborar
-
CODE_OF_CONDUCT.md
com boas práticas de convivência - Código de Conduta Debian
-
CHANGELOG.md
com histórico de alterações - GitPage com:
- Landing page - visão de produto (ex: Discourse)
- Arquitetura da solução
- Roadmap e backlog público
- Dicionário de dados (se aplicável)
- Documentação técnica de como contribuir
📢 Comunicação e Comunidade¶
- Sistema de governança (ex: mantenedores, comitês, votação)
- Constituição Debian
- Templates para issues e pull requests
- Templates de Issues
- Etiquetas (labels) para organizar issues
- Issues no Salsa
- Agendas públicas de reuniões (caso ocorram)
- Eventos são divulgados: Eventos Debian Brasil
⚖️ Licenciamento e Aspectos Legais¶
-
LICENSE
com licença de software livre (ex: MIT, GPL, Apache 2.0) - Licença Debian
- Verificação de licenças das dependências utilizadas
- Termos de uso e política de privacidade (para projetos web/app)
- Política de Privacidade Debian
🧪 Qualidade e Testabilidade¶
- Cobertura de testes mínima estabelecida e monitorada
- Testes end-to-end automatizados (se aplicável)
- Ferramentas de análise estática de código
- Monitoramento de qualidade com badges (ex: Codecov, SonarCloud)
📈 Sustentabilidade e Crescimento¶
- Roadmap público com funcionalidades desejadas
- Planejamento de onboarding de novos contribuidores (documentação de onboarding)