Skip to content

chore: templates de issue/PR, CODEOWNERS e caminho de entrada pra contribuir - #22

Merged
janeiaraujo merged 2 commits into
mainfrom
chore/community-templates
Aug 3, 2026
Merged

chore: templates de issue/PR, CODEOWNERS e caminho de entrada pra contribuir#22
janeiaraujo merged 2 commits into
mainfrom
chore/community-templates

Conversation

@janeiaraujo

Copy link
Copy Markdown
Owner

O problema

O CONTRIBUTING.md já existia e é bom, mas quem chegava com vontade de ajudar não tinha por onde começar: nenhum template de issue, nenhum template de PR, nenhuma indicação de tarefa pequena. O atrito de contribuir estava todo na cabeça de quem chega.

O que entra

  • Templates de issue (bug e feature) em formato de formulário, pedindo o que realmente falta quando um relato chega solto: passos para reproduzir, logs, versão e ambiente. O de feature pergunta o problema antes da solução, e tem um checkbox de "tenho interesse em implementar".
  • config.yml direciona dúvida de uso para Discussions e falha de segurança para o canal privado de advisory — evita que alguém publique uma vulnerabilidade numa issue aberta.
  • Template de PR com "o que / por quê / como testar" e um checklist curto. Inclui a regra de tenant_id nas queries, que é o erro mais fácil de cometer neste projeto e o mais caro (vazamento entre organizações).
  • CODEOWNERS para revisão solicitada automaticamente, já com o exemplo comentado de como dividir por área quando houver mais mantenedores.
  • CONTRIBUTING aponta para os templates, para as issues good first issue e para o canal de segurança.

Ainda falta (faço em seguida)

Criar as issues marcadas como good first issue. Vou abrir junto com o restante da sequência que combinamos, aproveitando os pontos que já mapeei no código — assim cada uma nasce com contexto real em vez de ser tarefa inventada.

Test plan

  • YAML dos três templates validado
  • Após o merge: abrir uma issue de teste e conferir que o seletor de template aparece
  • Conferir que o template de PR carrega ao abrir um PR novo

…tribuir

O CONTRIBUTING.md ja existia, mas quem chegava com vontade de ajudar
nao tinha por onde comecar: sem template de issue, sem template de PR,
sem indicacao de tarefas pequenas.

- ISSUE_TEMPLATE (bug e feature) em formato de formulario, com os
  campos que realmente faltam quando um relato chega solto: passos,
  logs, versao, ambiente.
- config.yml direciona duvida de uso para Discussions e falha de
  seguranca para o canal privado de advisory, em vez de issue publica.
- PULL_REQUEST_TEMPLATE com "o que/por que/como testar" e um checklist
  curto - inclui a regra de tenant_id, que e o erro mais facil de
  cometer neste projeto.
- CODEOWNERS: revisao solicitada automaticamente, e ja deixa comentado
  como dividir por area quando houver mais mantenedores.
- CONTRIBUTING aponta para os templates, para as issues good first
  issue e para o canal de seguranca.
Copilot AI review requested due to automatic review settings August 3, 2026 18:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Reduz o atrito de contribuição no repositório ao adicionar templates de issue/PR, direcionamento para suporte e canal privado de segurança, e revisão automática via CODEOWNERS, além de atualizar o guia de contribuição com pontos de entrada.

Changes:

  • Atualiza CONTRIBUTING.md com links para templates, good first issue e reporte privado de segurança.
  • Adiciona template de Pull Request com seções e checklist (incluindo regra de tenant_id).
  • Adiciona templates de issue (bug/feature), config.yml de issue templates e CODEOWNERS.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
CONTRIBUTING.md Adiciona links e orientações para orientar novos contribuidores e reporte de segurança.
.github/PULL_REQUEST_TEMPLATE.md Define estrutura e checklist do PR para padronizar descrições e reduzir erros comuns.
.github/ISSUE_TEMPLATE/feature_request.yml Formulário para pedidos de funcionalidade focado no problema e intenção de contribuir.
.github/ISSUE_TEMPLATE/config.yml Direciona dúvidas para Discussions e segurança para advisory privado.
.github/ISSUE_TEMPLATE/bug_report.yml Formulário de bug com passos de reprodução, área, logs, versão e ambiente.
.github/CODEOWNERS Configura owner padrão e documenta exemplo de divisão por área.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +25 to +27
- [ ] Se merece uma nova versão, bumpei `backend/package.json` **e** `frontend/package.json` juntos ([Versionamento](../README.md#versionamento))
- [ ] Não incluí segredos, `.env` ou dados reais
- [ ] Consultas novas ao MongoDB filtram por `tenant_id` ([Multi-tenant](../CONTRIBUTING.md#multi-tenant))
@janeiaraujo
janeiaraujo merged commit 4e4eb87 into main Aug 3, 2026
3 checks passed
@janeiaraujo
janeiaraujo deleted the chore/community-templates branch August 3, 2026 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants