cozie-app / cozie-apple

https://cozie-apple.app
GNU Lesser General Public License v3.0
15 stars 9 forks source link

Create naming conventions #51

Closed mariofrei closed 2 years ago

mariofrei commented 2 years ago

Influx DB column names

By now, we have many column names in the Influx DB. It might be worthwhile to come up with some naming conventions. Here are a few suggestions:

I have noticed that there are some issues with underscores "_" and dashes "-" for column names in influx DB, i.e., sometimes underscores get translated into dashes. I am not sure where this issue comes from. Hence, should we use dashes or underscores for column names?

Variable names

Regarding variables in the code, we could also try to improve consistency by using the same variable names through different systems. Here are some examples:

Cozie versions

We expect researchers to create their own Cozie versions with changes, improvements, and additional features to the "base" version. Hence the question is how should these versions be named for the sake of order? Here are some suggestions:

  1. Cozie - Orenth, Cozie - IEQ
  2. Cozie Orenth, Cozie IEQ
  3. Cozie (Orenth), Cozie (IEQ)
  4. CozieOrnenth, CozieIEQ
  5. Orenth - Cozie, IEQ - Cozie
  6. Orenth Cozie, IEQ Cozie

Documentation

If this turns out to be a worth agreeing on, we could add this to the documentation.