Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (33 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.19 KB
Raw

MailSpoof — Contributing Guide

Professional Email Spoofing and Phishing Simulation Framework

Guidelines for contributing code, reporting bugs, and submitting pull requests.

Thank you for your interest in contributing!

Contribution Workflow

flowchart LR
    A[Fork Repo] --> B[Make Changes on main]
    B --> C[Run Tests<br/>py_compile + bash -n]
    C --> D[Commit & Push to main]
    D --> E[Open Pull Request]
    E --> F[Review & Merge]
Loading

How to Contribute

  1. Fork the repository
  2. Edit files directly on the main branch
  3. Commit your changes (git commit -m "Add feature")
  4. Push to your fork (git push origin main)
  5. Open a Pull Request from main

Branching Policy

MailSpoof uses a single-branch model.

  • Only the main branch exists and is active
  • Do not create feature branches (git checkout -b is not used)
  • Do not create release branches
  • All changes go through Pull Requests from main

Requirements

  • Python 3.8+
  • Follow existing code style
  • Run python -m py_compile lib/*.py before submitting
  • Ensure bash -n install.sh passes

Legal

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.