Contributing to Kali Portable: Guidelines & Standards

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/V0rt3xS0urc3/RedTeam-Portfolio/llms.txt

Use this file to discover all available pages before exploring further.

​

Ways to Contribute

​

Pull Request Workflow

git clone https://github.com/<your-username>/RedTeam-Portfolio.git
cd RedTeam-Portfolio/kali-portable

# Bug fix
git checkout -b fix/error-hashcat-gpu

# New feature
git checkout -b feat/soporte-amd-rocm

# Documentation improvement
git checkout -b docs/mejora-instalacion-wsl

cd docker
docker build -t kali-pentest-test .
docker run --rm -it kali-pentest-test bash

git commit -m "fix: corregir detección de GPU en contenedores WSL2"
git commit -m "feat: agregar soporte para reglas Hashcat personalizadas"
git commit -m "docs: actualizar instrucciones de instalación en macOS"

git push origin fix/error-hashcat-gpu

​

Coding Standards

​

Dockerfile Standards

RUN apt update && apt install -y --no-install-recommends \
    nmap masscan nikto \
    && apt clean && rm -rf /var/lib/apt/lists/*

​

Bash Script Standards

• Always start with #!/bin/bash — do not use /bin/sh or /usr/bin/env bash
• Validate inputs early — check that required files and directories exist before operating on them
• Use color variables for user output — define RED, GREEN, CYAN, YELLOW, and NC at the top of the script and use them consistently for all printed messages
• Never hardcode credentials, tokens, or API keys — use environment variables or volume-mounted files for any sensitive data

#!/bin/bash
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
CYAN='\033[0;36m'
NC='\033[0m'

# Validate required argument
if [ -z "$1" ]; then
    echo -e "${RED}[!] Usage: $0 <capture.hc22000>${NC}"
    exit 1
fi

# Validate file exists before operating
if [ ! -f "$1" ]; then
    echo -e "${RED}[!] File not found: $1${NC}"
    exit 1
fi

​

Required Tests Before Opening a PR

cd kali-portable/docker
docker build -t kali-pentest-test .

cd kali-portable
./run-kali.sh normal

# Inside the container
ls /root/pentest/
touch /root/pentest/loot/test.txt && echo "✅ Write OK"

# Inside the container
hashcat -I
# Must list at least one NVIDIA device under 'OpenCL Info'

# Inside the container
auto-crack-wpa2.sh --help || auto-crack-wpa2.sh
setup-wifi.sh --help || setup-wifi.sh

​

Security Vulnerability Reporting

1. Affected component — Dockerfile, a specific script, a dependency, or the overall configuration
2. Reproduction steps — the minimal sequence of commands needed to trigger the vulnerability
3. Potential impact — what an attacker could achieve (e.g., container escape, credential exposure, privilege escalation)
4. Suggested fix (optional but appreciated) — a patch, configuration change, or alternative approach

​

What NOT to report here

• General support questions or configuration mistakes — open a regular Issue instead
• Vulnerabilities in bundled third-party tools (Metasploit, Hashcat, etc.) — report those directly to the upstream maintainers
• Issues caused by running the container outside its intended scope (e.g., exposing ports to the public internet)

​

Response Timeline

​

License