search

eclipse / kuksa.val

kuksa.val
Apache License 2.0
88 stars 52 forks source link

Consistent naming convention #376

Open lukasmittag opened 1 year ago

lukasmittag commented 1 year ago

Define a consistent naming convention for the packages of kuksa.val e.g. kuksa-feeders kuksa_databroker kuksa-val-server.

Everything camel case or everything separated by dash

erikbosch commented 9 months ago

We have a proposal at https://github.com/eclipse/kuksa.val/wiki/KUKSA-Naming-Guidelines Guess that is sufficient, or what do you think @lukasmittag ?

lukasmittag commented 9 months ago

Yes, its documented well now. What I meant by this is also the underscores and dashes. I think we there should also agree on one way forward. So using only dashes or underscores in all names and not having one name dashed and one name underscored.

erikbosch commented 9 months ago

Yes there should definitively be a pattern, and when we move to new repos is a good time to enforce it. I know that for instance pyoi do not like/accept underscore, but can we use dash/minus everywhere?, or is it so that we need to use both underscore and dash/minus, but specify preferred alternative for cases where both can be used.

lukasmittag commented 9 months ago

I can not think of cases were dashes wouldn't work. But for example for the structure of kuksa client directory it was necessary. I guees it would have been dumb to name both folders kuksa-client and so there is one kuksa_client directory with a kuksa-client folder in it.

lukasmittag commented 4 months ago

since we're moving to a new organization. This is discussed an will be finished soon.