deis / charts

(OBSOLETE) Helm Classic v1 Charts for Deis Workflow
https://deis.com/workflow/
MIT License
45 stars 36 forks source link

snake_case or camelCase-- we should pick one and stick to it #333

Closed krancour closed 8 years ago

krancour commented 8 years ago

In generate_params.toml, there are many places where snake_case has been used to delimit words, but there are also many places where camelCase has been used to the same effect. The overall effect of not having settled on a single convention and stuck to it is that it doesn't look quite as professional as it ought.

Can we pick one convention to use going forward and, remediate occurrences of the other? (In docs, too, where applicable!)

To answer the obvious question about this breaking things... I don't believe it does unless someone were to mix and match manifests from one version and generate_params.toml from another.

mboersma commented 8 years ago

Let's normalize this for the "new helm" version of Workflow charts. For Helm classic it may be problematic to change them at this point.

helgi commented 8 years ago

The decision is to make it snake_case, but only in the new charts @kmala is working on.

Reason behind snake_case is that is easier to read when there is no text highlighting and many software use this format in their configs, see nginx, php, gunicorn and many more.