Open brucellino opened 4 months ago
Today I just came across https://github.com/flox/flox which may also help us keep a consistent environment throughout.
This actually looks like a really good idea. I was going to suggest using asdf instead, but I was convinced by this comment in the Elixr forum. Coming from the Nix world, and assuming the project will be stable long term, it looks like a good approach.
Re-organise development environment page
In order to contribute anything, you likely need the dev env working. I hold that this should be on a single page.
In the page https://docs.egi.eu/about/contributing/git/#installing-dependencies there is mention of installing NodeJS as a dependency. I propose suggesting the use of NVM.sh for contributors to manage various Node versions:
NVM.sh
is just a shell script which can be added using thecurl - | bash
method, and provides functionality similar to python's virtual environments.Further, it's stated that NodeJS 12 should be used in the environment, but this is not declared anywhere. We should add it to
package.json
Finally, if we merge #636 we will obviate the need for many of the local tests reproducing the checks run in the actions CI checks, since they will be taken care of by the pre-commit framework. For now, I propose keeping the existing documentation, but instructing contributors to install the pre-commit hooks when contributing.
Summary of proposed changes
I propose: