Skip to content
This repository has been archived by the owner on Aug 30, 2021. It is now read-only.

File naming conventions: Users (Admin) module versus Article module #817

Closed
vaucouleur opened this issue Aug 17, 2015 · 11 comments
Closed

Comments

@vaucouleur
Copy link
Contributor

There are two minor (harmless) inconsistencies in the naming of the view files :

  • either object-verb ("user-edit") versus verb-object ("edit-article")
  • the view page being either object alone ("user") versus view-object ("view-article")

Users (admin) pages:

  • user-edit.client.view.html
  • user.client.view.html
  • user-list.client.view.html

versus Article pages:

  • edit-article.client.view.html
  • view-article.client.view.html
  • list-articles.client.view.html
@lirantal
Copy link
Member

@vaucouleur right.
you're welcome to suggest a convention and a PR, once we've made a decision to resolve it.

@codydaig
Copy link
Member

I personally like the structure of the article page names.

@mleanos
Copy link
Member

mleanos commented Aug 18, 2015

Same here. I prefer the articles view naming convention.

@vaucouleur
Copy link
Contributor Author

Ok, thanks for the feedback.

There is also a simple, yet important, argument in favor of the Article module naming convention: there is much more generated "Article" (or "Article-like") modules out-there, than the relatively recent "user admin" pages. The changes should have relatively less impact in terms of merging.

@rhutchison Is renaming the files using the Article module convention OK with you ?

@trainerbill
Copy link
Contributor

I like user.list.client.html or article.list.client.html. Or list.article.client.html. I like sticking with dots as that is how most other things are named. I can include the article pieces in my refactor once its concluded:

#800

@lirantal
Copy link
Member

I thought this whole question was about whether the convention is to use 'user' as a first word in the files or the actual action 'list', so basically it's 'user.list' vs 'list.user'

Whether we use dots or dashes doesn't really matter to me, but I tend towards dots as I see it also used in other frameworks.

So I think we're quite in agreement here?
@ilanbiala or @rhutchison ?

@trainerbill
Copy link
Contributor

I personally like list.user.client.html. Person is going to know they are in the users module so its important to put the action first. IMO

@mleanos
Copy link
Member

mleanos commented Aug 19, 2015

👍 I agree that the action should be first in the naming convention... and I prefer dots as well.

@vaucouleur
Copy link
Contributor Author

I messed up the initial PR while trying to do some git surgery (conflict resolution). Sorry about that. I will re-submit a new one.

@lirantal
Copy link
Member

Sure

@vaucouleur
Copy link
Contributor Author

I hope I did not miss anything.

I only renamed one controller, 3 html view pages, and edited one route file.

The other files already followed the verb-object.client convention.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants