Skip to content

Latest commit

 

History

History
145 lines (100 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

145 lines (100 loc) · 3.44 KB
layout title
default
Contributing

Contributing to subenum

We welcome contributions! Please read this guide to understand how you can contribute.

See the Code of Conduct.

Development Environment Setup

Prerequisites

  • Go 1.22 or later
  • Git
  • Make (optional but recommended)
  • Docker (optional, for containerized development)

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork: 
    git clone https://github.com/YOUR-USERNAME/subenum.git
cd subenum
  3. Set up the upstream remote: 
    git remote add upstream https://github.com/TMHSDigital/subenum.git

Development Workflow

Using Make

The project includes a Makefile to simplify development tasks:

# Build the binary
make build

# Run tests
make test

# Run linter
make lint

# Clean up build artifacts
make clean

# Run the tool with default parameters
make run

Using Docker

You can use Docker for development to ensure a consistent environment:

# Build the Docker image
make docker-build

# Run the tool in a Docker container
make docker-run

Pull Request Process

  1. Create a branch for your feature:

    git checkout -b feature/your-feature-name

  2. Make your changes and ensure they follow the project's coding standards

  3. Test your changes:

    make test
make lint

  4. Commit your changes with a clear message describing the change

  5. Push to your fork:

    git push origin feature/your-feature-name

  6. Create a pull request to the main repository

  7. Address any feedback from the code review

Ethical Guidelines

Please ensure that any contributions adhere to the ethical usage principles of this project:

  • Features should be designed for educational or legitimate security testing purposes
  • Consider potential misuse and implement appropriate safeguards
  • Document proper usage scenarios and any necessary warnings

Reporting Bugs

  1. Search existing issues first to avoid duplicates.
  2. Open a new issue using the Bug Report template.
  3. Include:
    • The exact command you ran
    • Your OS, Go version, and subenum version (./subenum -version)
    • Full terminal output (redact any sensitive domain names)
    • Expected vs. actual behaviour

Do NOT include sensitive information, unauthorized scan results, or private domain details.

Suggesting Features

  1. Search existing issues to avoid duplicates.
  2. Open a new issue using the Feature Request template.
  3. Describe:
    • The problem the feature solves
    • Your proposed solution
    • Legitimate security testing use cases it enables

Features that could primarily enable malicious use will be declined.

Simulation Mode for Development

Use -simulate to develop and test without making real DNS queries:

./subenum -simulate -hit-rate 30 -w examples/sample_wordlist.txt example.com

This lets you iterate on output formatting, flag handling, and new features safely.

Testing Requirements

All pull requests must pass the full test suite, including the race detector:

go test -v -race ./...

New features should include tests. New flags must be covered by at least one test case. Add network-dependent tests under if testing.Short() { t.Skip(...) } so they can be skipped in offline environments.