Propose a variable/function/method/class name.
Context/Purpose: [What does the code do? Why is it needed?]
Domain: TypeScript, Node.js, NestJS, [industry] (Calendar scheduling app)
Scope: [Used across the app for consistency]
Key Priorities: Readability, maintainability, brevity, follows [NestJS] conventions, humor
Constraints/Conventions:
- Try to stick the limit to 1-3 words, use 4 if necessary for specificity
- A name must be short, intuitive and descriptive:
- Short. A name must not take long to type and, therefore, remember;
- Intuitive. A name must read naturally, as close to the common speech as possible;
- Descriptive. A name must reflect what it does/possesses in the most efficient way.
- Avoid
- Contractions
- Context duplication
- For function follow A/HC/LC Pattern: [Prefix?] + [Action] + [High Context] + [Low Context?]
- Actions: get, set, reset, remove, delete, compose, handle
- Prefixes: is, has, should, min/max, prev/next If necessary to add type to name, you can use words "Pool Cache Dict Map Collection List Array Object Structure" as suffix If necessary to add size to name, you can use words "Tiny Small Normal Big Huge Enormous" as suffix or prefix Example of Bad Names: ?