Inspect linters and highlight available resources during course

amangoel185 commented 5 months ago

Decide on a linter (e.g. Flake8) and show compliance with PEP8.
Possible to use ruff (https://github.com/astral-sh/ruff) - or highlight it as an available tool
Highlight pre-commit hooks as an available tool too

amangoel185 commented 5 months ago

@Scottan - feel free to add suggestions!

Scottan commented 5 months ago

Note this issue has come up in the above feature, as VS code needs to have linters added whereas previously pycharm would do pep8 linting by default.

My suggestion:

Add instructions to install Flake8 for this course and for exercise in 15-coding-conventions.md, as it is simple and does pep8
Include suggestions of other possible tools (e.g. Pylint, Ruff, any other suggestions) or pre-commit hooks.
Have some recommendations about being consistent, especially in larger projects with multiple developers/languages.

Any thoughts / other suggestions?

carpentries-incubator / python-intermediate-development-earth-sciences