-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathNAMING.txt
50 lines (37 loc) · 1.57 KB
/
NAMING.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
////////////
// Some naming patterns because you are all over the place ...
////////////
# Put Resource First and THEN generic Nouns
# MAJOR : Generic Nouns at the end of things
# - ie. log / charts / tabs / history
selectedSupplementsCorrelationsTab
sleepHistory
# try to have correlation after the resource even though it will sound odd sometimes
supplementCorrelationCharts
# try to make restful resource as early in the word as possible
supplementCorrelationCharts
# Always put User in front of any resource where it makes sense
UserActivities
# something that indicates selected goes before everything else!
selectedSupplementsCorrelations
# When in doubt of singular versus plural, just pick plural, so lean toward plural
UserActivitiesEvents
# when comparing things like Sleep and Supplements, pick the resource that's closest to the page first
# so if you're on sleep.js
sleepSupplementsCorrelations
# or if you can ... remove sleep from the name altogether (if you're in the sleep folder)
supplementsCorrelations (does this sound better with supplementCorrelations) instead?
# try to put data near the end of variables
historyChartData
# try to call the javascript files that just hold abstract classes
base.js
# try to make correlations plural
SleepSupplementsCorrelationsTests
# try to have aggregates/averages come after the resource
# make sure its plural
ProductivityLogAggregatesView
SleepAggregatesView
SleepAveragesView
# try to have the full django model in the name, easier to decide on that pattern
# make the resource ... plural
ProductivityLogsSupplementsCorrelationsView