Reescreve README com objetivo RCT, testes e parâmetros de configuração#90
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:make django_test,pytest, Compose, CI)README.txtcomo referência detalhadaNão altera código de runtime, settings nem CI — apenas documentação.
Onde a revisão poderia começar?
README.mdComo este poderia ser testado manualmente?
README.mdno GitHub ou no editor e confirmar que links (docs/testing.md, wiki do modelo,README.txt) resolvem corretamente.make build,make up,make django_migrate— deve coincidir com o fluxo já usado no projeto.make django_testemake pytest— devem passar (1 smoke test) se a infraestrutura de testes estiver no mesmo branch.Algum cenário de contexto que queira dar?
docs/pr/2026-05-15-test-infrastructure.md): o README passa a documentar os mesmos comandos econfig.settings.testpara quem clona o repositório.README.txtserve quem prefere documentação offline ou em terminal;README.mdé a face pública no GitHub.Screenshots
N/A
Quais são tickets relevantes?
N/A
Referências
README.txtREADME.mddocs/testing.md.cursor/rules/project-objectives.mdc