Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (22 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.15 KB

Contributing to PhantomCrawler

Thank you for your interest in contributing to PhantomCrawler! We welcome bug reports, feature requests, and code contributions.

How to Contribute

  1. Report Issues:

    • Open an issue on the GitHub repository.
    • Provide a clear description, steps to reproduce, and any relevant logs or screenshots.

  2. Submit Pull Requests:

    • Fork the repository.
    • Create a new branch (git checkout -b feature/your-feature).
    • Make your changes and test thoroughly.
    • Commit with a clear message (git commit -m "Add your feature").
    • Push to your fork (git push origin feature/your-feature).
    • Open a pull request with a detailed description of your changes.

  3. Code Style:

    • Follow Python PEP 8 guidelines.
    • Ensure your code is well-documented.
    • Test your changes with various configurations (e.g., different depths, threads).

  4. Ethical Use:

    • Ensure any testing or demonstrations comply with the project's ethical use policy (see README).

Contact

For questions, reach out via GitHub issues.

Thank you for helping improve PhantomCrawler!