Add pre-commit for liniting docs #321
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The corresponding workflow is still missing. |
The develop branch is the one rendered on the website. Will you add the workflow as well? |
|
Done. I removed the markdown workflow as it is now covered by pre-commit. |
|
Can you please also add a quick mention in the CONTRIBUTING.md? https://github.com/precice/openfoam-adapter/blob/develop/CONTRIBUTING.md |
|
Done |
MakisH
added
the
dev
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds pre-commit hooks for linting the markdown docs as well as ensuring added images have the correct prefix.