ref: improving development environment and instructions #5180
Conversation
This file contains 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
dosubot
bot
added
the
size:XL
mieslep
changed the title
DEVELOPMENT.md
Outdated
|
|
||
| ### Option 1 (Preferred): Use a Dev Container | ||
|
|
||
| Open this repostiory as a Dev Container per your IDEs instructions. |
There was a problem hiding this comment.
Suggested change
| Open this repostiory as a Dev Container per your IDEs instructions. | |
| Open this repository as a Dev Container per your IDEs instructions. |
DEVELOPMENT.md
Outdated
| * **`make`**: The project uses `make` to coordidinate packaging. | ||
| * **`uv`**: This project uses `uv` (`>=0.4`), a Python package and project manager from Astral. Install instructions at https://docs.astral.sh/uv/getting-started/installation/. | ||
| * **`npm`**: The frontend files are built with Node.js (`v22.12 LTS`) and `npm` (`v10.9`). Install instrucations at https://nodejs.org/en/download/package-manager. | ||
| * Windows (WSL) users: ensure `npm` is installed within WSL environment; `which npm` should resolve to a Linux location, not a Windows location. |
There was a problem hiding this comment.
Maybe there's an extra space here?
Suggested change
| * Windows (WSL) users: ensure `npm` is installed within WSL environment; `which npm` should resolve to a Linux location, not a Windows location. | |
| * Windows (WSL) users: ensure `npm` is installed within WSL environment; `which npm` should resolve to a Linux location, not a Windows location. |
There was a problem hiding this comment.
I've switched this to a -, it is meant to be an indented sublist as it applies to npm but only Windows users.
ogabrielluiz
requested changes
Dec 10, 2024
There was a problem hiding this comment.
One thing I would add to this is that we have debug configuration for VSCode and the developer can run it by pressing F5 in the editor or going to the debug tab.
|
@ogabrielluiz edits pushed! |
ogabrielluiz
approved these changes
Dec 12, 2024
There was a problem hiding this comment.
Copilot reviewed 4 out of 8 changed files in this pull request and generated 1 suggestion.
Files not reviewed (4)
- .devcontainer/Dockerfile: Language not supported
- .devcontainer/demo/devcontainer.json: Language not supported
- .devcontainer/devcontainer.json: Language not supported
- Makefile: Language not supported
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR improves the ability for contributors to build and test changes, including better support for Windows users.
devcontainermore closely-aligned with CI/CD container definitionDEVELOPMENT.mdand expandedMakefile