Skip to content

Adicionar templates de contribuição: ISSUE_TEMPLATE e PULL_REQUEST_TEMPLATE focados em contratos #15

Description

@4lessandrodev

Visão geral

Guiar contribuidores sem contexto: qualquer issue/PR deve declarar impacto, risco e compatibilidade.

Contexto

Contribuidores externos precisam de estrutura. Em contratos, a falta de rigor vira quebra de compatibilidade e risco reputacional (PII, linguagem acusatória).

Descrição

Criar:

  • .github/ISSUE_TEMPLATE/contract-change.yml com campos:

    • motivação
    • quais schemas/openapi serão afetados
    • exemplos antes/depois
    • impacto (breaking?)
    • referência ao ROADMAP
    • checklist de risco (PII, linguagem)
  • .github/PULL_REQUEST_TEMPLATE.md com:

    • tipo de mudança (schema/openapi/examples/tooling)
    • breaking change? bump SemVer?
    • exemplos atualizados?
    • pnpm validate/test/generate rodou?
    • verificação de RISK_POLICY (PII / termos proibidos)

Referenciar docs oficiais do projeto no template.

Impacto

Reduz PRs ruins, acelera revisão e mantém projeto juridicamente defensável.

Referências

Definição de pronto

  • Templates adicionados em .github/
  • Campos cobrem compatibilidade, risco e testes
  • README aponta para o fluxo de contribuição

Tags

  • priority:medium
  • type:docs
  • area:community
  • good first issue

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions