search

precice / openfoam-adapter

OpenFOAM-preCICE adapter
https://precice.org/adapter-openfoam-overview.html
GNU General Public License v3.0
135 stars 80 forks source link

Add pre-commit for liniting docs #321

Closed fsimonis closed 6 months ago

fsimonis commented 7 months ago

This PR adds pre-commit hooks for linting the markdown docs as well as ensuring added images have the correct prefix.

fsimonis commented 7 months ago

The corresponding workflow is still missing. Which branches need to be checked?

MakisH commented 7 months ago

The corresponding workflow is still missing. Which branches need to be checked?

The develop branch is the one rendered on the website. Will you add the workflow as well?

fsimonis commented 7 months ago

Done. I removed the markdown workflow as it is now covered by pre-commit.

MakisH commented 6 months ago

Can you please also add a quick mention in the CONTRIBUTING.md?

https://github.com/precice/openfoam-adapter/blob/develop/CONTRIBUTING.md

fsimonis commented 6 months ago

Done