Skip to content

Reescreve README com objetivo RCT, testes e parâmetros de configuração#90

Merged
gitnnolabs merged 1 commit into
scieloorg:mainfrom
gitnnolabs:update_readme
May 15, 2026
Merged

Reescreve README com objetivo RCT, testes e parâmetros de configuração#90
gitnnolabs merged 1 commit into
scieloorg:mainfrom
gitnnolabs:update_readme

Conversation

@gitnnolabs
Copy link
Copy Markdown
Contributor

@gitnnolabs gitnnolabs commented May 15, 2026

O que esse PR faz?

Reescreve a documentação de entrada do repositório, que descrevia o MarkAPI de forma genérica (marcação/validação/conversão XML) e apontava sobretudo para cookiecutter-django, sem alinhar ao SciELO RCT nem à infraestrutura atual.

Entregas:

  • README.md (atualizado) — versão Markdown para o GitHub:
    • Resumo do objetivo RCT em tabela
    • Início rápido com Docker/Make e portas locais
    • Comandos de teste (make django_test, pytest, Compose, CI)
    • Tabelas de settings e variáveis principais
    • Link para README.txt como referência detalhada

Não altera código de runtime, settings nem CI — apenas documentação.

Onde a revisão poderia começar?

  1. README.md

Como este poderia ser testado manualmente?

  1. Abrir README.md no GitHub ou no editor e confirmar que links (docs/testing.md, wiki do modelo, README.txt) resolvem corretamente.
  2. Seguir a secção Desenvolvimento do README: make build, make up, make django_migrate — deve coincidir com o fluxo já usado no projeto.
  3. Seguir a secção Testes: make django_test e make pytest — devem passar (1 smoke test) se a infraestrutura de testes estiver no mesmo branch.
  4. Conferir que credenciais reais não aparecem no README (apenas nomes de variáveis e placeholders).

Algum cenário de contexto que queira dar?

  • Complementa o PR de infraestrutura de testes (docs/pr/2026-05-15-test-infrastructure.md): o README passa a documentar os mesmos comandos e config.settings.test para quem clona o repositório.
  • README.txt serve quem prefere documentação offline ou em terminal; README.md é a face pública no GitHub.
  • Referência de produto: especificação SciELO RCT v4.0; detalhes arquiteturais continuam no RCT/wiki quando aplicável.

Screenshots

N/A

Quais são tickets relevantes?

N/A

Referências

@gitnnolabs gitnnolabs self-assigned this May 15, 2026
@gitnnolabs gitnnolabs added the enhancement New feature or request label May 15, 2026
@gitnnolabs gitnnolabs merged commit 2783608 into scieloorg:main May 15, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant