Skip to content

[DOC] Add Windows development setup guide and fix mysqlclient installation #725

@rupeshca007

Description

@rupeshca007

Problem

The current documentation does not cover Windows-specific
setup issues. Contributors on Windows face multiple blockers:

  1. mysqlclient fails to build without Microsoft C++ Build Tools
  2. No mention of docker-compose.yaml (vs .yml) filename
  3. No Windows-specific instructions in CONTRIBUTING docs

Proposed Solution

  • Add a Windows setup section to the contributing guide
  • Document the mysqlclient fix for Windows
  • Clarify correct docker compose commands for Windows

Environment

  • OS: Windows 11
  • Python: 3.14
  • Docker: 29.2.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions