search

PH-Tools / PHX

Passive House Exchange (PHX) model format and tools for model I/O
GNU General Public License v3.0
1 stars 3 forks source link

Adding instructions on how to set up a local development environment #34

Closed ranms25 closed 10 months ago

ranms25 commented 1 year ago

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:

  1. 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.
  2. 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.
  3. 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