Skip to content
This repository has been archived by the owner on Dec 29, 2017. It is now read-only.

Silly module naming convention #1

Open
JoshuaKGoldberg opened this issue Aug 20, 2015 · 0 comments
Open

Silly module naming convention #1

JoshuaKGoldberg opened this issue Aug 20, 2015 · 0 comments
Labels

Comments

@JoshuaKGoldberg
Copy link
Member

To reiterate, the module naming convention is that each module should...

  • be 10 letters long
  • consist of a noun and verb
  • end in a vowel then 'r'
  • be named as '---------r' with instances being referred to as '---------er'
    • e.g. StyleGuider = new StyleGuidr(...);

Arguments against:

  • Limiting to 10 characters is not only arbitrary, but requires names to be unnecessarily vague, something which should be avoided. Modules (/ classes) should be named in a way that clearly expresses their purpose.
  • Requiring a module name to consist of a single noun followed by a verb is strange. Again, this is short-sighted, and makes names artificially vague. Are all of these modules meant to have a single functionality that is to take some action (verb) against a singular object (noun)? What happens when you start getting more nuanced modules that can't be expressed this way? This naming convention is not flexible for the future.
  • Requiring a class to end in an "er minus the e" suffix is also arbitrary, non-standard, and a confusing departure from the English language.
  • The argument that these naming conventions help with portability between projects is misguided. Any module named in a way that defines its purpose clearly (and within the conventions generally followed by the language) could be used in other projects. What would not fly in other projects is a bunch of rogue names with strange 10 character limitations and '-r' suffixing.

Arguments for:

  • I like it! ✨
  • Each module is its own software project with a separate source repo and can be used outside of FullScreenShenanigans; generic titles don't work well as software project titles.

Those lists are incomplete and will be added to as arguments come in.

@haydenmc

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

No branches or pull requests

1 participant