Skip to content

docs: align Copilot guidance with ShieldCode#10

Merged
nikolasdehor merged 2 commits into
mainfrom
chore/update-copilot-guidance
Jun 12, 2026
Merged

docs: align Copilot guidance with ShieldCode#10
nikolasdehor merged 2 commits into
mainfrom
chore/update-copilot-guidance

Conversation

@nikolasdehor

@nikolasdehor nikolasdehor commented Jun 12, 2026

Copy link
Copy Markdown
Member

Summary

  • Replaces stale Swift/macOS Copilot guidance with guidance for the actual ShieldCode security skill/docs/tooling repository.
  • Aligns stack, conventions, folder structure, local validation commands, and critical files with the README, skill docs, and workflows.

Validation

  • bash -n install.sh
  • bash -n uninstall.sh
  • Local assertion that stale Xcode/Swift/macOS guidance tokens are absent from .github/copilot-instructions.md.

Gate

  • No merge/release requested here. Merge still requires current CI plus review-gate triage for automated and human findings.

Summary by CodeRabbit

  • Documentation
    • Conteúdo de instruções atualizado para definir o repositório como um conjunto de regras/skills de segurança (ShieldCode) voltado ao hardening de código gerado por IA.
    • Regras e práticas focadas em JavaScript/TypeScript e Python.
    • Segurança por padrão: validação de entradas, prevenção de injeções, tratamento seguro de erros, autenticação/autorização, cabeçalhos de segurança e logging sem PII/segredos.
    • Referência principal reorganizada; metadados opcionais agora são tratados como não obrigatórios pelo fluxo.

Co-authored-by: Nikolas de Hor <116851567+nikolasdehor@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 34270f73-5a6a-4cfc-a956-f6761ccf12c6

📥 Commits

Reviewing files that changed from the base of the PR and between ca998d7 and db7aa57.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md

📝 Walkthrough

Walkthrough

Reescrita completa de .github/copilot-instructions.md: substitui orientações para macOS/Swift por um guia que define o ShieldCode como skill de segurança para Claude Code, referenciando skills/shieldcode/SKILL.md e detalhando práticas de segurança por padrão.

Changes

Instruções de Segurança do Copilot

Layer / File(s) Summary
Reescrita das instruções de segurança
.github/copilot-instructions.md
Conteúdo anterior genérico para macOS/Swift é substituído por orientação específica para ShieldCode como security skill. Stack orientado para JavaScript/TypeScript, Python e Bash. Convenções reforçam segurança por padrão: validação de input, prevenção de injeção, tratamento seguro de erros, autenticação/autorização, headers de segurança e logging sem PII/segredos. Referências explícitas a skills/shieldcode/SKILL.md, estrutura de pastas e validação via GitHub Actions. Alinha-se que plugin.json não existe e é opcional no workflow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutos

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed O título descreve com precisão a mudança principal: alinhar a orientação do Copilot com o ShieldCode, o que corresponde exatamente ao conteúdo alterado.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-copilot-guidance

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/copilot-instructions.md:
- Line 7: O arquivo viola MD022 (blanks-around-headings): adicione uma linha em
branco imediatamente após cada heading encontrado (por exemplo após "## Stack" e
as outras headings indicadas) para satisfazer a regra; edite as entradas de
heading (como "## Stack") para garantir que exista exatamente um blank line
abaixo de cada heading.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 8845e728-9067-492d-a150-936e2ad30464

📥 Commits

Reviewing files that changed from the base of the PR and between c7e2c2b and ca998d7.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md

Comment thread .github/copilot-instructions.md
Co-authored-by: Nikolas de Hor <116851567+nikolasdehor@users.noreply.github.com>
@nikolasdehor nikolasdehor merged commit d145a81 into main Jun 12, 2026
3 checks passed
@nikolasdehor nikolasdehor deleted the chore/update-copilot-guidance branch June 12, 2026 05:16
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