Fix readme papercuts, add process-compose.socket to .gitignore #2590
Conversation
| ``` | ||
| 5. Open a new terminal. Enter the development shell and start EvaP: | ||
| ``` | ||
| cd EvaP |
There was a problem hiding this comment.
It's not necessarily there but above it suggests cd ~.
There was a problem hiding this comment.
Urgh, this is ugliniess coming in from the NTFS/Windows workarounds. All commands here currently work anywhere on disk. With an absolute path, we drop that, which I think makes it a bit worse
I see your point about us mentioning ~ above in the Windows-only step. The path there is just supposed to be a weak suggestion to give users some option that works, since we'd expect them to be unfamiliar with the linux file system structure at that point.
I think it would be a bit better to try and reframe the contents of the windows-only point instead?
| - `./manage.py lint` | ||
| - `./manage.py format` (applies automatic code formatting) | ||
|
|
||
| or, to combine all three, simply run `./manage.py precommit`. |
There was a problem hiding this comment.
| or, to combine all three, simply run `./manage.py precommit`. | |
| or, to combine them, simply run `./manage.py precommit`. |
Maybe we should swap these and mention the precommit command first and then the list, idk
|
|
||
| or, to combine all three, simply run `./manage.py precommit`. | ||
|
|
||
| You can also set up `pylint`, `isort`, `black` and `prettier` in your IDE to avoid doing this manually all the time. |
There was a problem hiding this comment.
If we're touching this: We just removed isort in #2575, probably best to update this as well (add ruff, remove isort)
| htmlcov | ||
|
|
||
| # our nix setup produces this | ||
| process-compose.socket |
There was a problem hiding this comment.
Out of curiosity, what was your setup, Windows 11 with WSL 2? I think I have never seen this file mentioned by git. On my Linux, it's a socket, and git auto-ignores it.
2 participants
Small things I stumbled over while setting this up.