iceberg-project / Penguins

MIT License
3 stars 3 forks source link

Repository organization #1

Closed iparask closed 5 years ago

iparask commented 6 years ago

Trying to navigate the repo to find some information about the Software Requirements specification document for this use case, I realized that it is very difficult. Some pointers are:

  1. Avoid same naming between folders with different cases. For example, there is a folder named Exp and one called exp. That is not portable between systems.
  2. Folder naming should be self explanatory. There is no need for extremes, but the code can be under a folder named src and include subfolders that will show what it is in there in a word. For example, if there are 5 scripts that include utility functions they can all be under a folder named utils.
  3. Hidden and temp files should not be part of the repo. For example: https://github.com/iceberg-project/Penguins/blob/master/data/.mfolds_dataset.py.swn

I understand that the repo was refreshed in June, but I would like to ask if it can be brought to a state close to what our Development Documentation discusses.

Thank you