Skip to content

Add Cursor rules for project context, PR workflow and code style#77

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

Add Cursor rules for project context, PR workflow and code style#77
gitnnolabs merged 1 commit into
scieloorg:mainfrom
gitnnolabs:add_rules_cursor

Conversation

@gitnnolabs
Copy link
Copy Markdown
Contributor

@gitnnolabs gitnnolabs commented May 15, 2026

O que esse PR faz?

Adiciona regras persistentes do Cursor em .cursor/rules/ para orientar o agente de IA no desenvolvimento do MarkAPI (SciELO RCT):

Ficheiro Função
project-objectives.mdc Objetivos, escopo e princípios do SciELO RCT (resumo da especificação v4.0).
pr-commit.mdc Obriga insumo em docs/pr/ e mensagem de commit por tarefa com código.
deliverables-markdown-files.mdc Planos, tarefas e PRs como ficheiros .md em docs/.
no-comments.mdc Sem comentários nem docstrings em código novo ou alterado.
extract-function-on-reuse.mdc Funções só quando houver reuso real (≥2 usos).
python-black-isort.mdc Formatação Python com isort + Black (pyproject.toml).

Todas as regras de processo usam alwaysApply: true; python-black-isort.mdc aplica-se a **/*.py.

Onde a revisão poderia começar?

  1. .cursor/rules/project-objectives.mdc — alinhamento com a visão do produto.
  2. .cursor/rules/pr-commit.mdc — fluxo de entregáveis e PR.
  3. Demais ficheiros em .cursor/rules/ (regras curtas de estilo).

Como este poderia ser testado manualmente?

  1. Abrir o repositório no Cursor e confirmar que as regras aparecem em Project Rules / .cursor/rules.
  2. Iniciar um chat no Agent: pedir uma alteração Python e verificar se o agente segue Black/isort e evita comentários.
  3. Pedir uma tarefa com código e confirmar que é criado ficheiro em docs/pr/ conforme pr-commit.mdc.
  4. Perguntar objetivos do projeto e verificar se a resposta reflete project-objectives.mdc.

Não há alteração de runtime Django/Celery; não é necessário make django_test para validar este PR.

Algum cenário de contexto que queira dar?

As regras foram extraídas da especificação SciELO RCT (scielo_rct_v3_updated.docx, v4.0) e das convenções acordadas na equipa (entregáveis em Markdown, PR template em .github/PULL_REQUEST_TEMPLATE/pull_request_template.md).

Âmbito do commit/PR: apenas .cursor/rules/*.mdc e este insumo em docs/pr/. Não incluir alterações locais não relacionadas (ex.: config/settings/local.py, .gitignore, scripts, modelos LLM, .review_pr64/).

Screenshots

N/A

Quais são tickets relevantes?

N/A

Referências

  • SciELO RCT v4.0 (scielo_rct_v3_updated.docx)
  • Cursor — Project Rules
  • .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Introduce .cursor/rules/*.mdc so the agent applies SciELO RCT
objectives, mandatory docs/pr insumos, deliverables in Markdown,
no-comments policy,extract-on-reuse, and Black/isort for Python.
@gitnnolabs gitnnolabs self-assigned this May 15, 2026
@gitnnolabs gitnnolabs merged commit 2c20718 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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant