nils-braun / b2luigi

Task scheduling and batch running for basf2 jobs made simple
GNU General Public License v3.0
17 stars 11 forks source link

Improve development docs #73

Closed meliache closed 3 years ago

meliache commented 3 years ago

First I noticed the list of TODOs in the docs and this will never be up-to-date, so I linked to the issues instead.

Also added section how to run tests, as a motivation to do so before you do a PR, since we don't have real CI. Also I personally first failed at running the tests, e.g. I had tried to run python3 -m unittest from within the tests subdirectory, but then the relative imports don't work.

And I removed the

At a later stage, I will try to automate this.

since the reader might now understand I as the main author and I am not working on it. Also, this could also be made and enhancement issue.