Log Naming Convention: Difference between revisions
Jump to navigation
Jump to search
(Created page with "=Developer Logs= The Dev Log should be named under their colloquial first name - ie, what they go by in public - such as Emmanouil Log, Michael Log, Marcin Log, et...") |
No edit summary |
||
| Line 1: | Line 1: | ||
=General= | |||
The log name should be: | |||
#Two or more words | |||
#First word is a descriptive word or name | |||
#Initials of Each Word Are Capitalized | |||
#The word "Log" is the last word in the log name | |||
=Developer Logs= | =Developer Logs= | ||
The Dev Log should be named under their colloquial first name - ie, what they go by in public - such as [[Emmanouil Log]], [[Michael Log]], [[Marcin Log]], etc. In the log naming convention, first name is used when it is unique, but as soon as there are multiples of that first name, the last name is used. The first name that was unique remains - such as [[Michael Log]] for Michael Altfield - but subsequent Michaels add their last name, such as [[Michael Johnson Log]] for Michael Johnson. | The Dev Log should be named under their colloquial first name - ie, what they go by in public - such as [[Emmanouil Log]], [[Michael Log]], [[Marcin Log]], etc. In the log naming convention, first name is used when it is unique, but as soon as there are multiples of that first name, the last name is used. The first name that was unique remains - such as [[Michael Log]] for Michael Altfield - but subsequent Michaels add their last name, such as [[Michael Johnson Log]] for Michael Johnson. | ||
=Project Logs= | |||
The name of the log should be descriptive, so as to represent the content as best as possible. | |||
Latest revision as of 02:47, 18 August 2017
General
The log name should be:
- Two or more words
- First word is a descriptive word or name
- Initials of Each Word Are Capitalized
- The word "Log" is the last word in the log name
Developer Logs
The Dev Log should be named under their colloquial first name - ie, what they go by in public - such as Emmanouil Log, Michael Log, Marcin Log, etc. In the log naming convention, first name is used when it is unique, but as soon as there are multiples of that first name, the last name is used. The first name that was unique remains - such as Michael Log for Michael Altfield - but subsequent Michaels add their last name, such as Michael Johnson Log for Michael Johnson.
Project Logs
The name of the log should be descriptive, so as to represent the content as best as possible.