Skip to content

Conversation

@morotsgurka
Copy link
Contributor

@morotsgurka morotsgurka commented Sep 15, 2025

I noticed that the development setup for esphome has Windows separate at the bottom with different instructions and I'm not sure why?
And when actually reading the script/setup.bat file it even prints out the correct command to activate the virtual environment.

  • I cloned the repo.
  • I ran scripts/setup
  • I ran venv/Scripts/activate
  • Compile a sample config file with no issues

Also. The README contribute section does not mention to install the required pip packages (like mkdocs).

What changed?

  • Added Windows section to the venv activate section
  • Added pip install -r requirements.txt step before serve command in README

WIP
This probably needs more work since having both the separate instructions (at the bottom) and the working windows venv at the top could be confusing. At least clarify the reason for doing so?

Copilot AI review requested due to automatic review settings September 15, 2025 10:46
@netlify
Copy link

netlify bot commented Sep 15, 2025

Deploy Preview for esphome-dev-docs ready!

Name Link
🔨 Latest commit 48b9b1b
🔍 Latest deploy log https://app.netlify.com/projects/esphome-dev-docs/deploys/68c7f0d2388a2000086c8f3b
😎 Deploy Preview https://deploy-preview-57--esphome-dev-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Updates development environment documentation to improve cross-platform setup instructions and adds missing dependency installation step for contributors.

  • Consolidates Windows activation instructions with Linux/macOS instead of keeping them separate
  • Adds missing pip requirements installation step to README contribution guide

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/contributing/development-environment.md Adds Windows PowerShell activation command alongside existing Linux/macOS instructions
README.md Adds missing pip install requirements step to contribution workflow

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jesserockz jesserockz merged commit 7fdac34 into esphome:main Sep 15, 2025
4 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants