docs: improve conributing guide and fix linux developer setup script#1002
Merged
amilcarlucas merged 3 commits intoOct 31, 2025
Merged
Conversation
neo-0007
commented
Oct 30, 2025
neo-0007
commented
Contributor
- Add detailed steps in CONTRIBUTING.md to include developer environment setup , code execution guide and commit specification
- Fix developer environment setup script for Linux/MacOS by adding a venv creation and activation step
…setupDeveloperPC.sh Previously, setupDeveloperPC.sh for Linux/MacOS tried to install python packages even if no virtual environment is active It was causing to skip installation of packages leading to dependency issues This commit - checks if venv exists , if not than it creates it and activates it - added .venv/ to gitignore to stop tracking it Signed-off-by: neo-0007 <hrishikeshgohain123@gmail.com>
…G.md Added detailed steps for: - developer environment setup - running code locally - submitting patches - signing off commits Signed-off-by: neo-0007 <hrishikeshgohain123@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the developer setup process by adding automatic Python virtual environment creation to the Linux/MacOS setup script and updating the contributing documentation with clearer setup and contribution guidelines.
- Adds automatic
.venvcreation and activation inSetupDeveloperPC.sh - Updates
.gitignoreto exclude the new.venvdirectory - Restructures and expands
CONTRIBUTING.mdwith detailed setup instructions, execution commands, and commit signing guidelines
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| SetupDeveloperPC.sh | Added automatic virtual environment creation and activation before installing dependencies |
| .gitignore | Added .venv/ to ignored directories to complement existing venv/ exclusion |
| CONTRIBUTING.md | Restructured with new sections for learning, setup, execution, and patch submission with conventional commits and DCO signing |
Comments suppressed due to low confidence (2)
SetupDeveloperPC.sh:48
- Using
sudowithpipcan cause permission issues and conflicts with the virtual environment. Since the virtual environment is already activated at this point (line 33), this should use the virtual environment's pip withoutsudo:python3 -m pip uninstall -y serial pyserial
sudo python3 -m pip uninstall -y serial pyserial
SetupDeveloperPC.sh:52
- According to the project's coding guidelines, the project uses
uvfor dependency management, notpipdirectly. This should beuv pip install -e .[dev]to align with the documented standards in.github/copilot-instructions.md.
python3 -m pip install -e .[dev]
amilcarlucas
previously approved these changes
Oct 31, 2025
Remove redundant and outdated install_* scripts Signed-off-by: Dr.-Ing. Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
amilcarlucas
force-pushed
the
docs/improve-conributing-guide
branch
from
05b30d2 to
1a39cc0
Compare
amilcarlucas
approved these changes
Oct 31, 2025
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
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.