search

angular / angular-hint

run-time hinting for AngularJS applications
362 stars 45 forks source link

docs: how to write angular-hint vs. AngularHint vs Angular Hint #32

Closed ealtenho closed 9 years ago

ealtenho commented 9 years ago

@caguillen214 @btford

I'd like to describe in the Contributing guidelines where and when to use different ways of writing the names of AngularHint and the names of the various modules. Programmatically we care about each module being named ngHintNameHere in order to use the module prefixing/loading logic. However in our various documentation sources I'm feeling unsure of where to use angular-hint versus angularHint versus AngularHint. I notice that in this Readme we have angular-hint, but I'm wondering if that was the default generated by GitHub. I think that I would tend to use AngularHint and AngularHintModuleNameHere for modules. Is this a good standard for our Readme's and documentation?

ealtenho commented 9 years ago

@caguillen214 and I have decided that in Readme's AngularHint should be referred to as "Angular Hint" in titles. The same should go for individual modules such as "Angular Hint Modules", etc. There should not be a colon in these names. I will update the contributing guidelines to record this style choice and then close this issue.