search

DeepRegNet / Benchmark

Repositories for benchmarks with DeepReg and other methods.
Apache License 2.0
3 stars 0 forks source link

Code Format #2

Open mathpluscode opened 3 years ago

mathpluscode commented 3 years ago

For the py code, we can take a union of torchio and DeepReg unless we have conflicts. Although we should not have too many codes as we only need to call these packages.

In addition, I'd like to add https://github.com/python/mypy and http://www.pydocstyle.org/en/stable/index.html as the documentation can be critical for benchmarks.

What do you think @fepegar ?

fepegar commented 3 years ago

Sounds good. I'd say let's stay close to DeepReg style in terms of linting. I didn't know pydocstyle. I think pre-commit is very nice so that everything is checked at commit time.

In terms of commit messages, I like this style: https://chris.beams.io/posts/git-commit/ Which could be nicely used with this: https://slicer.readthedocs.io/en/latest/developer_guide/contributing.html#how-to-write-commit-messages

mathpluscode commented 3 years ago

Sounds good. I'd say let's stay close to DeepReg style in terms of linting. I didn't know pydocstyle. I think pre-commit is very nice so that everything is checked at commit time.

In terms of commit messages, I like this style: https://chris.beams.io/posts/git-commit/ Which could be nicely used with this: https://slicer.readthedocs.io/en/latest/developer_guide/contributing.html#how-to-write-commit-messages

Is there a way to force/check the commit messages? Last time I did not find a feasible solution.

fepegar commented 3 years ago

I'm not sure what you mean by force/check. In the CONTRIBUTING of TorchIO ou can find instructions to set up pre-commit. Let me know if it's not clear.

mathpluscode commented 3 years ago

I'm not sure what you mean by force/check. In the CONTRIBUTING of TorchIO ou can find instructions to set up pre-commit. Let me know if it's not clear.

Oh I mean, if people do not follow the commit message rules, or there's typo or so, will it be detectable ^^

fepegar commented 3 years ago

I don't know about the commit message. There's probably a way to enforce that with pre-commit, but I'm not sure.

We would just need to make sure that all developers have installed pre-commit in their local clones.

mathpluscode commented 3 years ago

I don't know about the commit message. There's probably a way to enforce that with pre-commit, but I'm not sure.

We would just need to make sure that all developers have installed pre-commit in their local clones.

cool, then fine. So regarding the commit message, it's just kind of agreement ^^. pre-commit can be easily handled inside conda.