Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (48 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 2.41 KB
Raw

Contributing

phishkit is GPL-3.0 software. By contributing, you agree that your contribution is distributed under GPL-3.0. Participation is governed by our Code of Conduct.

This repository is a primitive alpha (v0.1.x) — not a beta and not a production product. Do not commit walkthrough videos or upload them to GitHub Releases; generate MP4s locally if you need them.

phishkit is an authorized-assessment tool. Do not contribute features, presets, phishlets, or documentation whose primary purpose is to enable unauthorized use, evade lawful detection, or remove the authorized-use gate. See authorized use.

Languages

Surface Languages
Product (apps/, crates/, demos/, tests/integration) TypeScript + Rust
Automation (scripts/, kit/evilginx/scripts/) Python + shell OK
Vendored proxy Go only in vendor/evilginx2

Do not add Python inside app/UI/engine crates. Prefer Rust CLI/Tauri commands when automation becomes a product feature.

Practice apps live under demos/ (cookie, firebase).

Supported surface

The supported product is apps/desktop/, driven by make desktop. Shared engine: crates/phishkit-core/. CLI: apps/cli/.

Development

make setup          # rust toolchain check + desktop npm install + docs deps
make test           # cargo fmt --check + cargo test (core + cli)
make lint           # cargo clippy (workspace packages)
make test-integration-docker  # desktop UI suite (Docker + Xvfb; preferred)
make cli            # release CLI binaries
make desktop        # tauri dev

make help lists the full target set. Tests live under tests/. Never run the desktop UI suite without PHISHKIT_DATA / PHISHKIT_CONFIG sandboxed — make test-integration and make test-integration-docker set those for you. See Testing.

Docs

make docs           # VitePress preview
make docs-build     # production build (fails on broken internal links)

Docs live under docs/ and deploy to GitHub Pages from main. Prefer docs/guide/ and docs/reference/ for operator content.

Pull requests

  • Keep changes focused; match existing style.
  • Do not commit secrets, captures, run/ state, or node_modules/.
  • Keep the AUP/authorized-use gate and allow-listed session replay intact.