search

adareau / HAL

HAL Atom Locator
GNU General Public License v3.0
2 stars 1 forks source link

Code cleanup #28

Open adareau opened 3 years ago

adareau commented 3 years ago

At some point, before the project grows too big, we should do a major code cleanup. We have to come up with some naming rules. For instance, do we keep CamelCase names for the gui functions ? Right now there is some inconsistency... (that's my fault, of course)

quentinmarolleau commented 3 years ago

TODO LIST (to be edited):

Ok for CamelCase. If there is cleanup to do we should do it now. I also found some kek_list objects that actually were python dictionaries (cumbersome for stupid people like me...). What do you suggest to proceed to the cleanup ?

adareau commented 3 years ago

Here is what we could do: in my opinion, the only feature missing before a v0.1 is the batch fitting (#16). Once this is implemented, we could make a "freeze" branch from devel, in order to merge it to main for the v0.1. Then, we use this branch to implement hotfixes, and make the code cleanup.

For the code cleanup, it will be quite important to make pull requests, so that we can discuss the conventions and changes. Maybe we can make a list of all the files, and assign ourselves to a file once we start cleaning it up, so that there is no conflict. Then, we can make a cleanup/filename branch ?

quentinmarolleau commented 3 years ago

Ok I already made a cleanup branch with some minors corrections. Btw I self-assigned to https://github.com/adareau/HAL/issues/16

Additionally, the updateMetadataCache function generates a Cyclomatic complexity too high error: it probably needs to be optimized (reducing the usage of nested for and if).

adareau commented 3 years ago

so, about #46, please:

  1. branch it starting from 'devel' and not 'ROI'
  2. name it with the 'cleanup/xxx' convention