Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write down recommendations of folder naming #59

Open
jhnns opened this issue Mar 18, 2019 · 0 comments
Open

Write down recommendations of folder naming #59

jhnns opened this issue Mar 18, 2019 · 0 comments

Comments

@jhnns
Copy link
Member

jhnns commented Mar 18, 2019

ESLint doesn't have good rules to enforce specific folder or file naming conventions (there are plugins for this, but they're not really good).

Here are my thoughts on this topic:

  • In general, there are no "mandatory" rules for files and folder names. Each convention is fine as long as it is consistent throughout the project.
  • Most of the time we use camelCase:
    • starting with a lowercase letter for regular modules
    • starting with an uppercase letter (aka PascalCase) for things that can have instances (classes or components)
  • Should folder names be plural or singular? I think, this is a good answer. Use plural if the directory name describes their "type", use singular if it describes something beyond their type. This is a perfect example: pictures/Jacobs Birthday pictures is the type, Jacobs Birthday groups the pictures in a different way.

We should write down a list with recommendations.

@jhnns jhnns changed the title Write down recommendation of folder naming Write down recommendations of folder naming Mar 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant