Conversation
Added Windows setup instructions to README.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThe README now documents a Windows setup path alongside the existing workflow, replacing the Unix-specific environment-file copy command with its Windows equivalent. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README.md" line_range="76-80" />
<code_context>
cp .env.example .env
make dev
```
+# Setup, configure and run for windows
+make setup
+copy .env.example .env
+make dev
> Run `make help` to see all available commands. See [COMMANDS.md](./COMMANDS.md) for detailed workflows.
</code_context>
<issue_to_address>
**nitpick:** The Windows heading and its commands are placed after the closing Markdown code fence, so `make setup`, `copy .env.example .env`, and `make dev` render as ordinary paragraph text rather than a copyable command block.
**Suggested fix:** Add a separate fenced code block around the Windows heading and commands, or move the heading outside the block and wrap only the commands in a Windows-compatible fence.
</issue_to_address>
### Comment 2
<location path="README.md" line_range="76-79" />
<code_context>
-# Setup, configure and run
+# Setup, configure and run
make setup
cp .env.example .env
make dev
```
+# Setup, configure and run for windows
+make setup
+copy .env.example .env
+make dev
> Run `make help` to see all available commands. See [COMMANDS.md](./COMMANDS.md) for detailed workflows.
</code_context>
<issue_to_address>
**issue:** The Windows instructions invoke `make setup` and `make dev` without specifying WSL, Git Bash, or another POSIX shell, but the `setup` target runs the `swagger` recipe using POSIX shell syntax (`if command -v ...; then`), which fails when GNU Make uses the native Windows command shell.
**Triggers:** When a user follows these steps from native Windows Command Prompt with Make installed but without a POSIX-compatible shell.
**Suggested fix:** State that the commands must be run in WSL/Git Bash, or provide a native Windows setup path and Windows-compatible Make recipes.
```suggestion
# Setup, configure and run for Windows (using WSL or Git Bash)
make setup
cp .env.example .env
make dev
```
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: README.md:79
Comment on lines
+76
to
80
| # Setup, configure and run for windows | ||
| make setup | ||
| copy .env.example .env | ||
| make dev | ||
|
|
There was a problem hiding this comment.
nitpick: The Windows heading and its commands are placed after the closing Markdown code fence, so make setup, copy .env.example .env, and make dev render as ordinary paragraph text rather than a copyable command block.
Suggested fix: Add a separate fenced code block around the Windows heading and commands, or move the heading outside the block and wrap only the commands in a Windows-compatible fence.
Comment on lines
+76
to
+79
| # Setup, configure and run for windows | ||
| make setup | ||
| copy .env.example .env | ||
| make dev |
There was a problem hiding this comment.
issue: The Windows instructions invoke make setup and make dev without specifying WSL, Git Bash, or another POSIX shell, but the setup target runs the swagger recipe using POSIX shell syntax (if command -v ...; then), which fails when GNU Make uses the native Windows command shell.
Triggers: When a user follows these steps from native Windows Command Prompt with Make installed but without a POSIX-compatible shell.
Suggested fix: State that the commands must be run in WSL/Git Bash, or provide a native Windows setup path and Windows-compatible Make recipes.
Suggested change
| # Setup, configure and run for windows | |
| make setup | |
| copy .env.example .env | |
| make dev | |
| # Setup, configure and run for Windows (using WSL or Git Bash) | |
| make setup | |
| cp .env.example .env | |
| make dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added Windows setup instructions to README.
Description
Related Issue
Closes #(issue_number)
Type of Change
Testing
Screenshots (if applicable)
Checklist
Additional Notes
Summary by Sourcery
Documentation: