Add pre-commit hooks
Merge request reports
Activity
requested review from @hans.fangohr
added 1 commit
- 557f2d02 - add pre-commit dev-dependency to pyproject.toml
- development.rst 0 → 100644
1 Developers Setup RST is different from markdown, and you have learned markdown first, so perhaps that is why you consider it strange ;-). I agree the links are more intuitive in markdown.
RST is more powerful, and the language used in sphinx and (often?) python docstrings.
One feature I like in particular for README.rst files is that you can have a table of content created (which is not supported by markdown).
I am all in favour of sticking to RST. I think I have fixed most of this file already?
- Resolved by Ashwin Kumar Karnad
- Resolved by Ashwin Kumar Karnad
- Resolved by Ashwin Kumar Karnad
- Resolved by Ashwin Kumar Karnad
- Resolved by Ashwin Kumar Karnad
- Resolved by Ashwin Kumar Karnad
- Resolved by Ashwin Kumar Karnad
If we assume every developer runs the pre-commit hooks, then no violation of that should ever be committed. But of course we cannot enforce that.
How about we add a new workflow (or a command to our existing style checks) that runs the pre-commit checks and fails if it detects a violation? This way, we maintain the standard even if somebody doesn't use the pre-commit hooks. (As a downside: if you don't want to install the pre-commit hooks, and then the CI complains, then it is getting increasingly harder to fix this. On the positive: this will prevent that violations of the standards are detected by the next developer. )
added 2 commits
Im trying to add
rstcheck
to check the rst files we have. I fixed a few errors that it showed but i cant make sense of one of the error:rstcheck.................................................................Failed - hook id: rstcheck - exit code: 1 README.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3) Error! Issues detected.
is this one obvious to you @hans.fangohr? I have reduced the verbosity for now to get that check passing
Edited by Ashwin Kumar KarnadIs this still an open question? @akarnad
mentioned in commit b322f8f3
mentioned in issue #17 (closed)