Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (78 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

116 lines (78 loc) · 2.43 KB

Contributing to WireTapper 🤝

Thank you for your interest in contributing to WireTapper! This project focuses on Wireless OSINT & Signal Intelligence 📡 and values ethical, responsible, and collaborative development.

All contributions are welcome, whether code, documentation, ideas, or feedback.

🚀 Getting Started

  1. Fork the repository 🍴
  2. Clone your fork: 
    git clone https://github.com/yourusername/WireTapper.git
  3. Create a new branch: 
    git checkout -b feature/my-feature
  4. Make your changes ✍️
  5. Commit with a clear message: 
    git commit -m "Add: meaningful description"
  6. Push and open a Pull Request 🔁

🧠 Contribution Guidelines

Please follow these guidelines:

  • Write clean, readable, and maintainable code 🧩
  • Follow existing project structure and conventions
  • Keep commits focused and well-described
  • Comment complex logic when necessary
  • Test changes before submitting ✅

🐞 Reporting Bugs

If you find a bug 🪲, please open an issue and include:

  • A clear title
  • Steps to reproduce
  • Expected vs actual behavior
  • Logs or screenshots (if available)

💡 Feature Requests

Have an idea or improvement? ✨

Please include:

  • The problem it solves
  • How it benefits OSINT or SIGINT workflows
  • Any risks or limitations

🔐 Security & Ethical Use

WireTapper is intended for legal, ethical, and defensive use only.

⚠️ Contributions must not:

  • Enable illegal surveillance
  • Violate privacy or consent
  • Promote misuse of wireless intelligence tools

📏 Code Style

  • Follow PEP 8 for Python 🐍
  • Use meaningful names for variables and functions
  • Avoid committing API keys or secrets 🔑
  • Keep functions modular and readable

📚 Documentation

Documentation matters 📖

You can help by:

  • Improving README clarity
  • Adding usage examples
  • Fixing typos or broken links

🧪 Testing

If your change affects functionality:

  • Add or update tests when possible
  • Ensure existing features still work

📬 Need Help?

  • Check open issues labeled good first issue
  • Ask questions in issues or pull requests 💬
  • Open a draft PR for early feedback

🙌 Final Note

Every contribution helps strengthen WireTapper. Thank you for supporting an ethical, open, and community-driven intelligence platform 🌍📡

Happy contributing! 🛡️