From ca998d78e1d8518e84381a129b866bfbede93f62 Mon Sep 17 00:00:00 2001 From: Nikolas de Hor Date: Thu, 11 Jun 2026 22:24:09 -0300 Subject: [PATCH 1/2] docs: align Copilot guidance with ShieldCode Co-authored-by: Nikolas de Hor <116851567+nikolasdehor@users.noreply.github.com> --- .github/copilot-instructions.md | 47 +++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index c811824..0152b6e 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,33 +1,40 @@ # Copilot Instructions — shieldcode ## Project Overview -Aplicação macOS em Swift (baseada em VibeTunnel xcworkspace). +ShieldCode é uma **skill de segurança para Claude Code**, não um projeto de aplicação. +O repositório contém documentação, exemplos e regras de hardening para orientar código gerado por IA (principalmente JavaScript/TypeScript e Python). ## Stack -- **Swift 5.9+** -- **SwiftUI** ou **AppKit** (verificar) -- **Xcode** workspace -- macOS target +- **Markdown + SKILL.md** (`skills/shieldcode/SKILL.md`) como fonte de instruções de implementação segura +- **JavaScript/TypeScript** e **Python** (exemplos de referência no README, exemplos e skill) +- **Bash** (`install.sh`, `uninstall.sh`) para instalação/desinstalação +- **GitHub Actions** para validações ## Conventions -- Swift Concurrency: `async/await`, `actor` para estado compartilhado -- Memória: sem retain cycles; `[weak self]` em closures que capturam self -- Sem force unwrap (`!`) exceto em IBOutlets ou casos com invariante claro -- `os.Logger` em vez de `print` em release -- Erros via `throws` + `Result` quando assíncrono -- Entitlements mínimos necessários; sandbox respeitado +- Seguir **todas** as regras não negociáveis do `skills/shieldcode/SKILL.md`. +- Segurança por padrão: validação de input, prevenção de injeções, tratamento seguro de erros, autenticação/autorização, headers de segurança e logging sem PII/segredos. +- Preferir patterns de produção: validação allowlist, queries parametrizadas, erros tipados/mapeados, backoff/jitter para retries e circuit breaker quando aplicável. ## Folder Structure -- `.xcworkspace` / `.xcodeproj` — workspace -- `Sources/` ou `/` — código Swift -- `*.entitlements` — entitlements +- `skills/shieldcode/SKILL.md` — regras principais (obra viva da skill) +- `examples/` — cenários de vulnerabilidade e versões hardened/vulnerable +- `.github/workflows/` — CI e automações de validação +- `install.sh`, `uninstall.sh` — scripts de distribuição/remoção +- `README.md` — visão de produto, cobertura e uso ## Development -- Abrir workspace no Xcode -- ⌘B build, ⌘R run, ⌘U test -- CLI: `xcodebuild` se houver script +- Não execute build de app; este repositório é documentação e instruções de skill. +- Para mudanças locais: validar os arquivos alterados em Markdown e scripts de instalação. +- CLI de referência: + - `bash -n install.sh` + - `bash -n uninstall.sh` + - `sed -n '1,260p' README.md` / `SKILL.md` para manter consistência de orientação + +## CI / Plugin +- O CI inclui validação de `install.sh`, `uninstall.sh` e verificação de frontmatter no `SKILL.md`. +- `plugin.json` não está presente no repositório hoje; o workflow atual trata essa ausência como opcional. ## Critical Files -- `.xcworkspace` — workspace principal -- `*.entitlements` — capabilities -- `Info.plist` — bundle config +- `skills/shieldcode/SKILL.md` — regras obrigatórias +- `README.md` — fonte de verdade para o escopo público da skill +- `.github/copilot-instructions.md` — alinhamento de orientação para Copilot From db7aa57664c1f414a1e880b1af837357a017ecca Mon Sep 17 00:00:00 2001 From: Nikolas de Hor Date: Fri, 12 Jun 2026 02:11:35 -0300 Subject: [PATCH 2/2] docs: fix Copilot guidance markdown spacing Co-authored-by: Nikolas de Hor <116851567+nikolasdehor@users.noreply.github.com> --- .github/copilot-instructions.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 0152b6e..ff36d17 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,21 +1,25 @@ # Copilot Instructions — shieldcode ## Project Overview + ShieldCode é uma **skill de segurança para Claude Code**, não um projeto de aplicação. O repositório contém documentação, exemplos e regras de hardening para orientar código gerado por IA (principalmente JavaScript/TypeScript e Python). ## Stack + - **Markdown + SKILL.md** (`skills/shieldcode/SKILL.md`) como fonte de instruções de implementação segura - **JavaScript/TypeScript** e **Python** (exemplos de referência no README, exemplos e skill) - **Bash** (`install.sh`, `uninstall.sh`) para instalação/desinstalação - **GitHub Actions** para validações ## Conventions + - Seguir **todas** as regras não negociáveis do `skills/shieldcode/SKILL.md`. - Segurança por padrão: validação de input, prevenção de injeções, tratamento seguro de erros, autenticação/autorização, headers de segurança e logging sem PII/segredos. - Preferir patterns de produção: validação allowlist, queries parametrizadas, erros tipados/mapeados, backoff/jitter para retries e circuit breaker quando aplicável. ## Folder Structure + - `skills/shieldcode/SKILL.md` — regras principais (obra viva da skill) - `examples/` — cenários de vulnerabilidade e versões hardened/vulnerable - `.github/workflows/` — CI e automações de validação @@ -23,6 +27,7 @@ O repositório contém documentação, exemplos e regras de hardening para orien - `README.md` — visão de produto, cobertura e uso ## Development + - Não execute build de app; este repositório é documentação e instruções de skill. - Para mudanças locais: validar os arquivos alterados em Markdown e scripts de instalação. - CLI de referência: @@ -31,10 +36,12 @@ O repositório contém documentação, exemplos e regras de hardening para orien - `sed -n '1,260p' README.md` / `SKILL.md` para manter consistência de orientação ## CI / Plugin + - O CI inclui validação de `install.sh`, `uninstall.sh` e verificação de frontmatter no `SKILL.md`. - `plugin.json` não está presente no repositório hoje; o workflow atual trata essa ausência como opcional. ## Critical Files + - `skills/shieldcode/SKILL.md` — regras obrigatórias - `README.md` — fonte de verdade para o escopo público da skill - `.github/copilot-instructions.md` — alinhamento de orientação para Copilot