Skip to content

Commit ca65f91

Browse files
committed
chore(.github): add copilot-instructions
1 parent 0cc9e01 commit ca65f91

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

.github/copilot-instructions.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Copilot Instructions
2+
3+
## Code Comments
4+
5+
Minimize comment usage to only strictly necessary places:
6+
7+
- **Avoid comments for self-explanatory code** - Well-named functions, variables, and clear logic should speak for themselves
8+
- **Use comments only when necessary** for:
9+
- Complex business logic that isn't immediately obvious
10+
- Non-obvious performance optimizations
11+
- Workarounds for bugs in external libraries
12+
- Regulatory or compliance requirements
13+
- Mathematical formulas or algorithms
14+
15+
Write code that is self-documenting through clear naming and structure rather than relying on comments.
16+
17+
## UI Text Conventions
18+
19+
Use **sentence case** for all UI text elements instead of Title Case. This includes:
20+
21+
- Button labels
22+
- Form field labels
23+
- Menu items
24+
- Section headings
25+
- Error messages
26+
- Tooltips
27+
- Any other user-facing text
28+
29+
### Examples
30+
31+
**Correct (sentence case):**
32+
33+
- "Portfolio longevity"
34+
- "Safe withdrawal rates"
35+
- "Historical data"
36+
- "Calculate returns"
37+
38+
**Incorrect (Title Case):**
39+
40+
- "Portfolio Longevity"
41+
- "Safe Withdrawal Rates"
42+
- "Historical Data"
43+
- "Calculate Returns"
44+
45+
### Exception
46+
47+
Only use title case for proper nouns and the first letter of sentences.

0 commit comments

Comments
 (0)