mirror of https://github.com/SquidSec/SquidC5 synced 2026-08-09 12:22:26 +00:00

Files

T

Mr. The Plague 067e66a59b docs: Diátaxis consistency pass across all guides

- docs/README: catalog, section templates, Ops nav → guide map
- user-guide: WWHE + See also; Artifacts, Profiles, OAST, TLS library, Post-Ex
- runbook: Goal/Prereqs/Steps/Verify/If fails on every procedure
- deployment: Context/Config/Commands/Verify; generic OAST examples; TLS anchor
- README/vision/threat/roadmaps/AGENTS/CLAUDE/CONTRIBUTING/SECURITY cross-links
- Ops PAGE_DOCS anchors aligned to new user-guide headings

2026-08-02 11:35:09 -04:00

2.3 KiB

Raw Blame History

Contributing to SquidC5

Authorized red-team / security research use only. Do not open issues or PRs that request help with unauthorized access.

Development cycle (required)

Update master (git pull).
Create a feature branch for one logical change.
Write unit tests first.
Implement the change.
Red-green-refactor until pytest -q and ruff check src tests pass.
Push the branch (never commit directly to master).
Open a pull request into master.
Wait for CI (tests, security, SquidGate when configured).
Merge only when green.
Start the next change from step 1.

Prefer small PRs. One fix or feature per cycle.

Local setup

python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements-dev.txt && pip install -e .
pytest -q
ruff check src tests

Security rules

Do not weaken MCP allow-lists, Admin AI sanitize_untrusted, empty CORS default, or the public_docs lock.
Never commit secrets, data/, tokens, or API keys.
New endpoints require auth and appropriate scopes.
Admin UI/JS (/api/v1/ops/admin.js) must stay admin-gated on the server.

CI

CI workflow: pytest (3.11/3.12), ruff, Docker smoke, pip-audit, binaries on master.
SquidGate (SquidSec/SquidGate@v1.0.0-build.4): PR security gate. Set repository secret LLM_API_KEY to enable full analysis.

Docs

Catalog and section templates: docs/README.md (Diátaxis: tutorials/how-tos vs reference vs explanation).

Doc	Role
AGENTS.md	Agent memory + full CLI surface
docs/user-guide.md	Feature reference (What/Why/How/Example)
docs/operator-runbook.md	Day-2 procedures
docs/deployment.md	Lab + prod binary
docs/squidc5-vision.md	Architecture
docs/roadmap-2026-2027.md	Long-range roadmap
docs/prod-readiness-plan.md	Engineering checklist

When you change operator-facing behavior, update the matching user-guide chapter and fix cross-links.

Pull requests

Use the PR template. Include:

What changed and why
Test plan (commands run)
Security impact notes when relevant

2.3 KiB Raw Blame History