Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding instructions to README file for set up a local development env #2

Closed
wants to merge 2 commits into from

Conversation

ranms25
Copy link

@ranms25 ranms25 commented Apr 27, 2023

Hi, this PR was sent as part of OSDC taught by: @szabgab. I want to contribute to your project by adding instructions on how to set up a local development environment using Docker in the project's README file. Is important for several reasons:

Ease of onboarding: new contributors or developers joining the project may not be familiar with the required software and libraries needed to develop and run the project. Providing clear instructions on how to set up a local development environment using Docker, it makes it easier for them to get up and running quickly.
Reproducibility: By using Docker to set up the local development environment, it ensures that all developers are using the same development environment with the same versions of software and libraries. This makes it easier to reproduce bugs and issues reported by other developers, as well as ensure that the project is built and tested in a consistent manner across different environments.
Isolation: Docker allows developers to create a containerized environment that is isolated from the host system, preventing potential conflicts with other software installed on the host. This helps ensure that the project's dependencies do not conflict with other software, potentially causing issues or breaking the development environment.
Thanks,
Ran

@vpaeder
Copy link
Owner

vpaeder commented Apr 27, 2023

Hi. Considering that this is a driver that needs access to a serial port, I nonetheless don't think dockerizing is the most appropriate option. Besides this is not meant to be a standalone app.
Thanks for your input anyway.

@ranms25
Copy link
Author

ranms25 commented Apr 28, 2023

Thanks for considering my contribution to the project.
I appreciate your perspective on why Dockerizing the driver may not be the best option.
I understand that the driver needs access to a serial port, which may not be feasible within a Docker container.
I also understand that the driver may not be meant to be a standalone app.
Thanks again for taking the time to review my contribution.

@ranms25 ranms25 closed this Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants