Skip to content

docs: completa os arquivos de comunidade e corrige as versões suportadas - #58

Merged
NullSablex merged 1 commit into
masterfrom
docs/arquivos-de-comunidade
Sep 26, 2026
Merged

NullSablex merged 1 commit into
masterfrom
docs/arquivos-de-comunidade

Conversation

@NullSablex

Copy link
Copy Markdown
Owner

Fecha a lacuna dos arquivos que o GitHub pede, tomando o email_samp como referência, e arruma a parte de versões do SECURITY.md.

Versões suportadas

A tabela dizia:

Version Supported
1.x (latest release) Yes
Older 1.x releases No
Pre-1.0 No

Não batia com as releases que existem de fato e obrigava quem lê a traduzir faixa para versão só para chegar na única informação que importa. Vira a mesma frase que o email_samp já usa:

Only the most recent release receives security fixes.

O número real fica onde ele já é mantido — a página de releases — em vez de duplicado num arquivo que envelhece sozinho.

De quebra o arquivo passa a seguir a mesma estrutura do email_samp (reporte → escopo → versões → dependências), para quem conhece um repositório achar as coisas no mesmo lugar no outro. O escopo agora lista o que é específico daqui em vez de genérico: injeção de SQL (incluindo escaping que não acompanha o sql_mode), TLS, vazamento de credencial no log, exaustão de memória alcançável do Pawn e o Argon2id.

Arquivos que faltavam

O email_samp tem, o mysql_samp não tinha:

  • CONTRIBUTING.md — build 32-bit, o que rodar antes do PR, e as regras em que se tropeça aqui: o .inc.in é a fonte (os outros dois são gerados e sobrescritos), native nova toca quatro lugares, Pawn é ASCII puro, pawncc não analisa função que ninguém chama, nada bloqueia o tick e ordem é propriedade do callback, não da execução. As duas últimas vieram direto do que apuramos nos testes desta semana.
  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1, o mesmo do email_samp.
  • .github/ISSUE_TEMPLATE/ — bug_report.yml, feature_request.yml e config.yml. O de bug pergunta o servidor (open.mp nativo, legacy ou SA-MP), a versão do plugin, o banco e qual dos dois includes, e avisa para não colar senha nem a query que o erro de sintaxe ecoou. O config.yml desliga issue em branco e oferece três atalhos: advisory privado, documentação e guia de migração.
  • .github/PULL_REQUEST_TEMPLATE.md — com os comandos de verificação que o CI cobra.

Verificação

  • YAML dos três templates validado
  • cargo test — 177 passed, 1 ignored
  • Guarda de codificação — OK, 21 arquivos

Sobre o CNAME que eu havia levantado no #57: entendido que o Pages guarda o domínio nas settings e não em arquivo, então não há nada a fazer ali.

A secao de versoes suportadas do SECURITY.md tinha uma tabela com
"1.x (latest release)", "Older 1.x releases" e "Pre-1.0". Nao batia com as
releases que existem de fato no GitHub e obrigava quem le a traduzir faixa
para versao, para chegar na unica informacao que importa. Vira a mesma
frase que o email_samp ja usa: so a release mais recente recebe correcao,
com link para a pagina de releases, que e onde o numero de verdade esta.

De quebra o arquivo passa a seguir a estrutura do email_samp - reporte,
escopo, versoes, dependencias -, para quem conhece um repositorio
encontrar as coisas no mesmo lugar no outro. O escopo agora lista o que e
especifico daqui: injecao de SQL (incluindo escaping que nao acompanha o
`sql_mode`), TLS, vazamento de credencial no log, exaustao de memoria
alcancavel do Pawn e o Argon2id.

Faltavam tambem os arquivos que o GitHub pede e que o email_samp ja tem:

- `CONTRIBUTING.md` — build 32-bit, o que rodar antes do PR, e as regras
  em que se tropeca: o `.inc.in` e a fonte, native nova toca quatro
  lugares, Pawn e ASCII puro, nada bloqueia o tick, e ordem e propriedade
  do callback e nao da execucao.
- `CODE_OF_CONDUCT.md` — Contributor Covenant 2.1, igual ao do email_samp.
- `.github/ISSUE_TEMPLATE/` — bug, feature e config. O de bug pergunta o
  servidor, a versao, o banco e qual dos dois includes, e avisa para nao
  colar senha nem query que o erro de sintaxe ecoou.
- `.github/PULL_REQUEST_TEMPLATE.md` — com os comandos de verificacao que
  o CI cobra.
@NullSablex
NullSablex merged commit 0c281af into master Sep 26, 2026
9 checks passed
@NullSablex
NullSablex deleted the docs/arquivos-de-comunidade branch September 26, 2026 12:19
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.

1 participant