[b/docs/gitfame_review_comments.md] Add note on inialisms.

2023-03-12 19:56:52 +03:00 · 2023-03-12 19:56:52 +03:00 · 16ef5385f8
commit 16ef5385f8
parent 6959d8ac5d
1 changed files with 23 additions and 0 deletions
--- a/docs/gitfame_review_comments.md
+++ b/docs/gitfame_review_comments.md
@ -160,6 +160,29 @@ Authors := make([]string)
 authors := make([]string)
 ```

+### Аббревиатуры должны писаться в single-case
+
+В том числе и конкатенации аббревиатур.
+
+https://github.com/golang/go/wiki/CodeReviewComments#initialisms
+
+
+Неправильно:
+```
+JsonLines
+Sha1
+printCsv
+XMLHttpRequest
+```
+
+Правильно:
+```
+JSONLines
+SHA1
+printCSV
+XMLHTTPRequest
+```
+
 ## Работа с language_extensions.json

 Некоторые решения читают файл с экстеншионами по относительному пути.