Add pre commit #66
Add pre commit #66
Conversation
| @@ -0,0 +1,21 @@ | |||
| default_language_version: | |||
| # all hooks should run with python 3.6+ | |||
There was a problem hiding this comment.
nit: I think the current version of pre-commit requires at least python 3.8
README.md
Outdated
|
|
||
| `Pre-commit` will then run automatically at each commit and will take care of installation and running of `Ruff`. | ||
|
|
||
| ## References |
There was a problem hiding this comment.
not sure I agree with this change – this section provides the citation people should use, rather than a list of references
There was a problem hiding this comment.
OK, I have seen both, but I agree that Citations is more precise, so I changed it. I will add there also other papers developing mlp-train once published.
| @@ -13,7 +14,7 @@ class MLPotential(ABC): | |||
|
|
|||
| def __init__(self, | |||
| name: str, | |||
| system: 'mlptrain.System'): | |||
| system: 'mlt.System'): | |||
There was a problem hiding this comment.
it would be really nice to make the type checking correct with something like this – appreciate that's a bunch of work though. feel free to ignore 😄
There was a problem hiding this comment.
Heh, yes, this is on my TODO list, right now I did only a quick fix to make Ruff happy. Thanks for providing the example and for review! :)
I added pre-commit hooks to check the files before committing. Additionally, I added checking the files by Ruff linter to catch possible bugs. This PR also includes changes suggested by Ruff, fixed either automatically or manually. At this stage, Ruff does not check for formatting issues, this will be added in follow-up PR. Coded with a help of @danielhollas