Cursor rule

1---
2description: When naming things - files, functions, urls, etc
3alwaysApply: false
4version: 1.0.0
5---
6 
7# Naming Conventions
8 
9When in doubt, take time to name things well. It's one of the hardest problems in
10computer science.
11 
12## Importance
13 
14- Names are a form of documentation that never goes out of date
15- Good names reduce cognitive load and make code self-documenting
16- Names should reveal intent and provide context
17- Time spent on naming is an investment in future understanding
18 
19## When to Pause and Consider Naming Carefully
20 
21The more permanent/harder to change, the more time to spend on naming:
22 
23- Creating new models or database tables
24- Defining core functions or classes
25- Establishing API endpoints or URLs
26- Naming background jobs or tasks
27- Creating new features or components
28- Defining key variables that appear throughout codebase
29 
30Notably, don't spend excessive time on naming for simple things that are easy to change.
31 
32## When Names Aren't Obvious
33 
34When a name for a new file, function, class, etc. isn't immediately obvious:
35 
36- Pause and ask what we should name it. It's better to ask than to guess and have to
37  rename later.
38- Consider multiple alternatives
39- Evaluate options based on:
40  - Clarity and intuitiveness
41  - Technical accuracy
42  - Future flexibility
43  - Project context
44