81 lines (63 loc) · 2.16 KB

Contributing to Bug Bounty Lab

Thanks for your interest in contributing! This guide covers the basics.

Getting Started

Fork the repository

Clone your fork:

git clone https://github.com/YOUR-USER/bugbounty-lab101
cd bugbounty-lab101

Create a feature branch:
```
git checkout -b feature/your-feature
```

Code Standards

Shell Scripts

Bash 4+ required (for associative arrays, ${BASH_SOURCE}, etc.)
Use set -eo pipefail at the top of all scripts
Use mktemp for temporary files — never predictable /tmp/name_$$ patterns

Add a cleanup trap for any temp resources:

source "$SCRIPT_DIR/lib/common.sh"
safe_tmpdir TEMP_DIR "myscript"
trap 'cleanup_tmpdir "$TEMP_DIR"' EXIT

Resolve script directory with:

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

Check tools before using them:

if command -v nmap &>/dev/null; then ...

Language

All user-facing output, comments, and documentation in English
Variable names and function names in English

Style

Use the shared library where possible:
```
source "$SCRIPT_DIR/lib/common.sh"
```
Run shellcheck before submitting:
```
shellcheck your-script.sh
```

What to Contribute

New scan modules — add as standalone scripts in auto-scanner/
Tool categories — update tools/registry.sh
Documentation — improve docs/, add CVEs to watchlists
Bug fixes — check Issues or find something that breaks
Wordlists / templates — improve bugbounty/templates/

Pull Request Process

Run shellcheck on any modified .sh files
Test your changes on Kali Linux (or equivalent)
Update relevant documentation if you add features
Keep PRs focused — one feature/fix per PR
Write a clear description of what changed and why

Scope & Ethics

This project is for authorized security testing only. Do not contribute:

Malicious tools designed for unauthorized access
Exploits without responsible disclosure context
Credentials, API keys, or personal data

Questions?

Open an Issue or start a Discussion on GitHub.