Steep and confusing learning curve to contributing about mbed-tools HOT 1 CLOSED

I just went through the process today with macOS Big Sur, so my $0.02 :)

• brew installs [email protected] now, there are now mentions of python 3.9 in the documentation so that can be a little confusing (I don't have a python background so it might be obvious for you guys)
• the documentation for pre-commit says it will run pytest but it's not the case. it took me some time to figure out that I just need to run pytest -- I had found a workaround with tox -e py39 but it messed everything up.
• i was not able to install everything with tox -e dev -- jellyfish in particular was failing. I has to install the requirements system wide to make it work
• the news file error message is cryptic if you don't know what it is, maybe pre-commit could create the file

I'm a big fan of Makefiles for pretty much everything that needs to call a script. make install_deps, make install_tox, make setup_env, make test, etc. could be easier as users won't have to know or remember the specific commands. It's also easier to open the Makefile and see what you can do with it than getting lost in documentation.

from mbed-tools.