Skip to content

Instantly share code, notes, and snippets.

View ZvanYang's full-sized avatar
🍊

Zhaoyang ZvanYang

🍊
  • beijing
View GitHub Profile
@ZvanYang
ZvanYang / naming_guidelines.md
Created March 20, 2023 07:27 — forked from IwoHerka/naming_guidelines.md
Naming Guidelines

Naming guidelines

1. Syntax

1.1 Be consistent

Consistency in naming makes reading and memory retrieval much, much easier. Conversely, changing rules and mixing conventions are very confusing and significantly increase cognitive load. Follow language, company, and project conventions for names, even if you don't like them.

1.2 Follow conventions

FWIW: I (@Rondy) am not the author of the content presented here, which is an outline from Edmond Lau's book. I've just copy-pasted it from somewhere and saved as a personal gist, before it got popular on newsnews.ycombinator.com. I don't remember where exactly the original source is from and neither could find the author's name, so I cannot give him/her the proper credits.


Effective Engineer - Notes