CONTRIBUTING.md

Contributing to DarkMatter Traffic Bot

We welcome contributions to the DarkMatter Traffic Bot! Here are some guidelines to help you get started.

How to Contribute

1. Fork the repository.
2. Clone your forked repository:

   git clone https://github.com/your-username/web-traffic-tool.git
   cd web-traffic-tool

3. Create a new branch for your feature or bug fix:

   git checkout -b feature/your-feature-name
   # or
   git checkout -b bugfix/issue-description

4. Set up your development environment: Ensure you have Python 3.10+ installed. It's highly recommended to use a virtual environment:

   python -m venv .venv
   # On Windows
   .venv\Scripts\activate
   # On macOS/Linux
   source .venv/bin/activate
   
   pip install -r requirements.txt

5. Make your changes.
   • Adhere to the existing code style.
   • Write clear, concise, and well-documented code.
   • Ensure your changes pass any existing tests.
6. Test your changes.
7. Commit your changes with a clear and descriptive commit message.
   • Use a Conventional Commits style (e.g., feat: Add new proxy protocol or fix: Resolve UI crash on start).
8. Push your branch to your forked repository:

   git push origin feature/your-feature-name

9. Create a Pull Request from your forked repository to the main branch of the original repository.
   • Provide a clear title and description for your pull request, explaining the changes and why they are necessary.

Reporting Bugs

If you find a bug, please open an issue on the GitHub repository. When reporting, please include:

• A clear and concise description of the bug.
• Steps to reproduce the behavior.
• Expected behavior.
• Screenshots if possible.
• Your operating system and Python version.

Suggesting Enhancements

If you have an idea for a new feature or an improvement, please open an issue to discuss it. We appreciate your suggestions!

---

Thank you for your contributions!