magpie-ea / magpie-modules

the reusable front-end bits in the _magpie modules
MIT License
7 stars 1 forks source link

Decide on case style in babe-project #23

Open JannisBush opened 5 years ago

JannisBush commented 5 years ago

At the moment, we have many different styles in the names of the different repositories in babe-project:

In the front-end code itself, there are also different styles present: e.g. deployMethod and contact_email in the call of babeInit.

In the downloaded csv data from the server app, there are also different styles present: e.g. submission_id and startTime.

I know it is difficult to find a coherent solution, because there are different predominating styles in the different programming communities. (javascript/node, elixir, R, Python) But I think, we should try to stick to one style in the complete project or to stick to the predominating style of the respective language.

I suggest to use snake case notation in the complete project, because, as far as I know, it is the preferred style in elixir and R, it is already used predominately in this project and I personally find it better readable.

michael-franke commented 5 years ago

I agree.

On Dec 5, 2018, at 12:03, JannisBush notifications@github.com wrote:

At the moment, we have many different styles in the names of the different repositories in babe-project:

snake case: babe_site kebab case: babe-project upper camel case: MinimalTemplate ColorReference lower camel case: departurePoint all caps: BABE In the front-end code itself, there are also different styles present: e.g. deployMethod and contact_email in the call of babeInit.

In the downloaded csv data from the server app, there are also different styles present: e.g. submission_id and startTime.

I know it is difficult to find a coherent solution, because there are different predominating styles in the different programming communities. (javascript/node, elixir, R, Python) But I think, we should try to stick to one style in the complete project or to stick to the predominating style of the respective language.

I suggest to use snake case notation in the complete project, because, as far as I know, it is the preferred style in elixir and R, it is already used predominately in this project and I personally find it better readable.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

x-ji commented 5 years ago

This might be useful: https://www.npmjs.com/package/eslint-plugin-eslint-snake-case

Most key names for downloaded data come from the frontend submission. Those names can also be changed in the frontend templates.

The naming of BABE is that we couldn't find a distinct name for the backend app... So I just went with that. Any suggestion?