Submitting a Pull Request

Before You Open the PR

Sync your branch with upstream/main:

git fetch upstream
git rebase upstream/main

Run the test suite — all tests must pass:
```
mvn test
```
Run Checkstyle — no violations:
```
mvn checkstyle:check
```
Test with a real cluster snapshot — if your change touches ingestion, analysis, or export.

Commit Message Format

Use a short imperative subject line (≤ 72 characters), optionally followed by a blank line and a longer body:

Add node_escape edge type for privileged container breakout

Containers running with hostPID=true or securityContext.privileged=true
now get a node_escape edge to the host Node resource. EdgeRiskScorer
assigns weight 0.1 (very easy traversal) to these edges.

Fixes #42

Subject line conventions:

Imperative mood: "Add", "Fix", "Remove", "Update" — not "Added" or "Adding"
No period at the end
Reference issues with Fixes #N or Closes #N in the body

Opening the PR

Push your branch to your fork:

git push origin feat/add-node-escape-edge

Open a Pull Request against main in the upstream repository.
In the PR description, include:
- What changed and why
- Related issues with Fixes #<number> or Closes #<number>
- Before/after console output or screenshots for user-facing changes
- Whether the change requires regenerated GraalVM metadata

PR Review Process

A maintainer will review your PR, typically within a few days
Address comments with new commits or by revising existing ones
Avoid force-pushing once a review is in progress (unless asked)
A clean, logical commit history is preferred — squash "fix typo" commits before the PR is merged

Security Vulnerabilities

Do not open public issues for security vulnerabilities. Report them privately via GitHub Security Advisories.

Reporting Bugs

Before opening a new issue, search existing issues to avoid duplicates.

When filing a bug report, include:

K8sAttackMap version or commit SHA
Operating system and architecture
Exact command you ran
Full console output (use --verbose for debug logs)
For parsing issues: a minimal anonymised cluster JSON that reproduces the problem

Community

For project discussion and announcements, join the Discord server (channel: #k8sattackmap). Security issues should be reported privately via GitHub Security Advisories, not on Discord.