42 lines (27 loc) · 1.3 KB

Contributing to Deep Focus

First off, thanks for taking the time to contribute! 🎉

Deep Focus is a "Mini Shodan" for personal use, and we want to keep it fast, efficient, and easy to use.

How Can I Contribute?

Reporting Bugs

Search Existing Issues: Make sure the bug hasn't been reported yet.
Use a Clear Title: Describe the issue clearly.
Provide Context: Include your OS, Python version, and what you were doing when the error occurred.
Terminal Output: Copy/paste the error logs or terminal output.

Suggesting Enhancements

Explain the Goal: What problem does your feature solve?
Describe the Solution: How should it work?

Pull Requests

Fork the Repo: Create your own copy of the project.
Branch: Create a new branch (git checkout -b feature/AmazingFeature).
Commit: meaningful commit messages are helpful.
Push: Push to your fork.
Open a Pull Request: Describe your changes and link any related issues.

Style Guide

Code Style: We try to follow PEP 8.
Type Hints: Please use Python type hints (typing module) for new code.
Docstrings: Document your functions and classes!

Code of Conduct

Be respectful and kind to others. We are here to learn and build cool tools.

Happy Hacking!

Y0oshi