- spaces around operators
- snake_case for variables and functions
- camelCase for classes and methods
- verbose naming is more important than a detailed documentation
- R code is tested using
testthat
and python code indev
branch usingunittest
- we try to keep
master
branch clean (i.e. production ready code). dev
branch should be also a working code, however here mistakes are permitted. Most of the development is done in subbranches ofdev
branch, once a feature is implemented, it should be merged todev
. I like to use--no-ff
to keep a record, what was developed where (this might be a bad practice and if you know why, let me know).- One rule I would like to keep is this. There must be at least 72 hours incubation period between commits merged into
dev
and mergingdev
intomaster
. The reason is simple, if there are any mistakes that were not spotted, there is a change to catch them. Also it takes while to run all the tests and stuff (the travis.ci testing is not working yet, but I hope it will quite soon).
The future is C
backend based on FastK, inference and plotting in R
and python
user interface.