fz0x1/HPI
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: update

Browse source
This commit is contained in:
Dima Gerasimov 2021-02-20 01:39:55 +00:00
parent 3b4a2a378f
commit ad1cc71b0f
8 changed files with 126 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/CONTRIBUTING.org Normal file
View file

@ -0,0 +1,10 @@
doc in progress
- I don't use automatic code formatters (like =black=)
I don't mind if you do, e.g. when you're adding new code or formatting some code you modified, but please don't reformat the whole repository or slip in unrelated code style changes.
In particular I can't stand when formatters mess with vertically aligned code (thus making it less readable!), or conform the code to some arbitrary line length (like 80 symbols).
Of course reasonable formatting improvements (like obvious typos, missing spaces or too dense code) are welcome.
And of course, if we end up collaborating a lot on the project I'm open to discussion if automatic code style is really important to you.