Contributing to ESP32-Wifi-Hacking

Thank you for your interest in contributing to the ESP32-Wifi-Hacking project! We welcome contributions from the community and are grateful for your support.

Guidelines for Contributing

Coding Standards

  • Follow the existing coding style and conventions used in the project.
  • Write clear and concise code with appropriate comments.
  • Ensure that your code is well-documented and includes necessary explanations.

Commit Message Conventions

  • Use clear and descriptive commit messages.
  • Follow the format: type(scope): subject
    • type: The type of change (e.g., feat, fix, docs, style, refactor, test, chore).
    • scope: The scope of the change (e.g., module, component, file).
    • subject: A brief description of the change.

Pull Request Process

  1. Fork the repository and create a new branch for your contribution.
  2. Make your changes and ensure that the code builds and passes all tests.
  3. Submit a pull request with a clear description of your changes.
  4. Address any feedback or comments provided during the review process.

Setting Up the Development Environment

To set up the development environment for ESP32-Wifi-Hacking, follow these steps:

  1. Clone the repository:

    git clone https://github.com/StepSisStuck/ESP32-Wifi-Hacking.git

  2. Navigate to the project directory:

    cd ESP32-Wifi-Hacking

Reporting Issues and Requesting Features

If you encounter any issues or have feature requests, please follow these guidelines:

  1. Check the existing issues to see if your problem or request has already been reported.
  2. If not, create a new issue with a clear and descriptive title.
  3. Provide detailed information about the issue or feature request, including steps to reproduce the problem if applicable.

If there is an issue

If you have any questions or need further assistance, you can create an issue, and I will get back to you!

Thank you for contributing to ESP32-Wifi-Hacking!