Probe-Particle / ppafm

Classical force field model for simulating atomic force microscopy images.
MIT License
49 stars 18 forks source link

Protocol for dealing with formatting changes needed #210

Closed mondracek closed 10 months ago

mondracek commented 11 months ago

We need to establish some recommended procedure how to deal with formatting changes required by the pre-commit hooks like flake and black. I am now being forced to redo part of my work on the code because my changes got buried in a flood of the automatic formatting changes I have foolishly accepted and no one, myself included, can tell apart the actual changes in the code submitted for review. Should we perhaps make a separate branch in which the automatic formatting will be applied to all files and nothing else will be done there? Then merge it into main and base all future work on the newly formatted files?

NikoOinonen commented 11 months ago

Yes, we should get on with this.

@yakutovicha We did one PR, but then stopped. What is your status on this?

In the meanwhile, I found that if you do SKIP=black commit then it does not apply black during the pre-commit hook.

yakutovicha commented 11 months ago

@ProkopHapala, @NikoOinonen will select parts of the code that shouldn't be formatted, and then we will apply black to the whole repository.