| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 6 | 23 | 0% |
| Commands | 0 | 0 | 0 | — |
| Section tags | 2 | 2 | 4 | 25% |
What each file covers
Sections
0 shared · 6 only in A · 23 only in B- − Code Style Guidelines
- − Formatting Standards
- − Naming Conventions
- − Function Structure
- − Comments
- − Error Handling
- + Twenty Development Rules
- + Rules Overview
- + Core Guidelines
- + Code Quality
- + React Development
- + Testing & Quality
- + Internationalization
- + How Rules Work
- + Automatic Attachment
- + Manual Reference
- + Rule Types Used
- + Development Commands
- + Frontend Commands
- + Backend Commands
- + Usage Guidelines
- + For Developers
- + For AI Assistants
- + Contributing to Rules
- + Adding New Rules
- + Updating Existing Rules
- + Rule Format Reference
- + Rule Title
- + Migration from Legacy Format
Commands
neither file has anySection tags
2 shared · 2 only in A · 4 only in B- − code-style
- − docs
- + test
- + types
- + database
- + do-not
- lint-format
- architecture
Line diff
nowtec/nowCRM · .cursor/rules/code-style.mdc
@@ −1 @@
1---
2description: Code style guidelines for NOWCRM
3globs:
4alwaysApply: true
5---
6# Code Style Guidelines
7
8## Formatting Standards
9- **Prettier**: 2-space indentation, single quotes, trailing commas, semicolons
10- **Print width**: 80 characters
11- **ESLint**: No unused imports, consistent import ordering, prefer const over let
12
13## Naming Conventions
14```typescript
15// ✅ Variables and functions - camelCase
16const userAccountBalance = 1000;
17const calculateMonthlyPayment = () => {};
18
19// ✅ Constants - SCREAMING_SNAKE_CASE
20const API_ROUTES_STRAPI = {
21 USERS: 'users',
22 CONTATs: 'contacts',
23} as const;
24
25// ✅ Types and Classes - PascalCase
26class UserService {}
27type UserAccountData = {};
28type ButtonProps = {}; // Component props suffix with 'Props'
29
30// ✅ Files and directories - kebab-case
31// user-profile.component.tsx
32// user-profile.styles.ts
33```
34
35## Function Structure
36```typescript
37// ✅ Small, focused functions
38// ✅ Required parameters first, optional last
39const processUserData = (
40 user: User,
41 options: ProcessingOptions,
42 callback?: (result: ProcessedUser) => void
43): ProcessedUser => {
44 const processedUser = transformUserData(user);
45 applyOptions(processedUser, options);
46
47 if (callback) {
48 callback(processedUser);
49 }
50
51 return processedUser;
52};
53```
54
55## Comments
56```typescript
57// ✅ Explain business logic and non-obvious intentions
58// Apply 15% discount for premium users with orders > $100
59const discount = isPremiumUser && orderTotal > 100 ? 0.15 : 0;
60
61// TODO: Replace with proper authentication service
62const isAuthenticated = localStorage.getItem('token') !== null;
63
64/**
65 * JSDoc for public APIs
66 * @param basePrice - The base price before modifications
67 * @returns The final price after tax and discount
68 */
69const calculateTotalPrice = (basePrice: number): number => {
70 // Implementation
71};
72```
73
74## Error Handling
75```typescript
76// ✅ Proper error types and meaningful messages
77try {
78 const user = await userService.findById(userId);
79 if (!user) {
80 throw new UserNotFoundError(`User with ID ${userId} not found`);
81 }
82 return user;
83} catch (error) {
84 logger.error('Failed to fetch user', { userId, error });
85 throw error;
86}
87```
nowtec/nowCRM · .cursor/rules/readme.mdc
@@ +1 @@
1---
2description: NOWCRM development rules and best practices
3globs: []
4alwaysApply: true
5---
6# Twenty Development Rules
7
8This directory contains NOWCRM's development guidelines and best practices in the modern Cursor Rules format (MDC). These rules are automatically applied based on file patterns and provide context-aware guidance to AI assistants.
9
10## Rules Overview
11
12### Core Guidelines
13- **architecture.mdc** - Project overview, technology stack, and infrastructure setup (Always Applied)
14
15### Code Quality
16- **typescript-guidelines.mdc** - TypeScript best practices and conventions (Auto-attached to .ts/.tsx files)
17- **code-style.mdc** - General coding standards and style guide (Auto-attached to code files)
18- **file-structure.mdc** - File and directory organization patterns (Auto-attached to config files)
19
20### React Development
21- **react-general-guidelines.mdc** - Core React development principles (Auto-attached to React files)
22
23### Testing & Quality
24- **testing-guidelines.mdc** - Testing strategies and best practices (Auto-attached to test files)
25
26### Internationalization
27- **translations.mdc** - Translation workflow and i18n setup (Auto-attached to locale files)
28
29## How Rules Work
30
31### Automatic Attachment
32Rules are automatically included in your AI context based on file patterns (globs). When you work on TypeScript files, the TypeScript guidelines are automatically loaded.
33
34### Manual Reference
35You can manually reference any rule using the `@ruleName` syntax:
36- `@react-general-guidelines` - Load React best practices
37- `@testing-guidelines` - Get testing recommendations
38
39### Rule Types Used
40- **Always Applied** - Loaded in every context (architecture.mdc, README.mdc)
41- **Auto Attached** - Loaded when matching file patterns are referenced
42- **Agent Requested** - Available for AI to include when relevant
43- **Manual** - Only included when explicitly mentioned
44
45## Development Commands
46
47### Frontend Commands
48
49todo:
50
51### Backend Commands
52
53todo:
54
55## Usage Guidelines
56
57### For Developers
58- Rules are automatically applied based on file context
59- Check rule descriptions to understand when they're activated
60- Use manual references (`@ruleName`) for additional context
61- Keep rules updated as the codebase evolves
62
63### For AI Assistants
64- Rules provide consistent guidance across conversations
65- Use rule context to maintain coding standards
66- Reference specific rules when making recommendations
67- Apply rule principles in code suggestions and reviews
68
69## Contributing to Rules
70
71### Adding New Rules
721. Create a new `.mdc` file in this directory
732. Include proper metadata headers with description and globs
743. Write clear, actionable guidelines with examples
754. Test the rule with relevant file patterns
765. Update this README if needed
77
78### Updating Existing Rules
791. Modify the rule content while preserving metadata
802. Test changes with affected file patterns
813. Ensure consistency with other rules
824. Update examples and best practices as needed
83
84## Rule Format Reference
85
86Each rule file uses the MDC format with metadata:
87
88```markdown
89---
90description: Brief description of the rule's purpose
91globs: ["**/*.ts", "**/*.tsx"] # File patterns for auto-attachment
92alwaysApply: false # Whether to always include this rule
93---
94
95# Rule Title
96
97Rule content in Markdown format...
98```
99
100## Migration from Legacy Format
101
102The rules have been migrated from the legacy `.md` format to the modern `.mdc` format, providing:
103- Better context awareness through file pattern matching
104- Improved organization with metadata headers
105- More flexible rule application strategies
106- Enhanced integration with Cursor's AI features
107
108For the most up-to-date version of these guidelines, always refer to the files in this directory.
@@ −1 +1 @@
11 ---
2−description: Code style guidelines for NOWCRM
3−globs:
2+description: NOWCRM development rules and best practices
3+globs: []
44 alwaysApply: true
55 ---
6−# Code Style Guidelines
6+# Twenty Development Rules
77
8−## Formatting Standards
9−- **Prettier**: 2-space indentation, single quotes, trailing commas, semicolons
10−- **Print width**: 80 characters
11−- **ESLint**: No unused imports, consistent import ordering, prefer const over let
8+This directory contains NOWCRM's development guidelines and best practices in the modern Cursor Rules format (MDC). These rules are automatically applied based on file patterns and provide context-aware guidance to AI assistants.
129
13−## Naming Conventions
14−```typescript
15−// ✅ Variables and functions - camelCase
16−const userAccountBalance = 1000;
17−const calculateMonthlyPayment = () => {};
10+## Rules Overview
1811
19−// ✅ Constants - SCREAMING_SNAKE_CASE
20−const API_ROUTES_STRAPI = {
21− USERS: 'users',
22− CONTATs: 'contacts',
23−} as const;
12+### Core Guidelines
13+- **architecture.mdc** - Project overview, technology stack, and infrastructure setup (Always Applied)
2414
25−// ✅ Types and Classes - PascalCase
26−class UserService {}
27−type UserAccountData = {};
28−type ButtonProps = {}; // Component props suffix with 'Props'
15+### Code Quality
16+- **typescript-guidelines.mdc** - TypeScript best practices and conventions (Auto-attached to .ts/.tsx files)
17+- **code-style.mdc** - General coding standards and style guide (Auto-attached to code files)
18+- **file-structure.mdc** - File and directory organization patterns (Auto-attached to config files)
2919
30−// ✅ Files and directories - kebab-case
31−// user-profile.component.tsx
32−// user-profile.styles.ts
33−```
20+### React Development
21+- **react-general-guidelines.mdc** - Core React development principles (Auto-attached to React files)
3422
35−## Function Structure
36−```typescript
37−// ✅ Small, focused functions
38−// ✅ Required parameters first, optional last
39−const processUserData = (
40− user: User,
41− options: ProcessingOptions,
42− callback?: (result: ProcessedUser) => void
43−): ProcessedUser => {
44− const processedUser = transformUserData(user);
45− applyOptions(processedUser, options);
46−
47− if (callback) {
48− callback(processedUser);
49− }
50−
51− return processedUser;
52−};
53−```
23+### Testing & Quality
24+- **testing-guidelines.mdc** - Testing strategies and best practices (Auto-attached to test files)
5425
55−## Comments
56−```typescript
57−// ✅ Explain business logic and non-obvious intentions
58−// Apply 15% discount for premium users with orders > $100
59−const discount = isPremiumUser && orderTotal > 100 ? 0.15 : 0;
26+### Internationalization
27+- **translations.mdc** - Translation workflow and i18n setup (Auto-attached to locale files)
6028
61−// TODO: Replace with proper authentication service
62−const isAuthenticated = localStorage.getItem('token') !== null;
29+## How Rules Work
6330
64−/**
65− * JSDoc for public APIs
66− * @param basePrice - The base price before modifications
67− * @returns The final price after tax and discount
68− */
69−const calculateTotalPrice = (basePrice: number): number => {
70− // Implementation
71−};
72−```
31+### Automatic Attachment
32+Rules are automatically included in your AI context based on file patterns (globs). When you work on TypeScript files, the TypeScript guidelines are automatically loaded.
7333
74−## Error Handling
75−```typescript
76−// ✅ Proper error types and meaningful messages
77−try {
78− const user = await userService.findById(userId);
79− if (!user) {
80− throw new UserNotFoundError(`User with ID ${userId} not found`);
81− }
82− return user;
83−} catch (error) {
84− logger.error('Failed to fetch user', { userId, error });
85− throw error;
86−}
34+### Manual Reference
35+You can manually reference any rule using the `@ruleName` syntax:
36+- `@react-general-guidelines` - Load React best practices
37+- `@testing-guidelines` - Get testing recommendations
38+
39+### Rule Types Used
40+- **Always Applied** - Loaded in every context (architecture.mdc, README.mdc)
41+- **Auto Attached** - Loaded when matching file patterns are referenced
42+- **Agent Requested** - Available for AI to include when relevant
43+- **Manual** - Only included when explicitly mentioned
44+
45+## Development Commands
46+
47+### Frontend Commands
48+
49+todo:
50+
51+### Backend Commands
52+
53+todo:
54+
55+## Usage Guidelines
56+
57+### For Developers
58+- Rules are automatically applied based on file context
59+- Check rule descriptions to understand when they're activated
60+- Use manual references (`@ruleName`) for additional context
61+- Keep rules updated as the codebase evolves
62+
63+### For AI Assistants
64+- Rules provide consistent guidance across conversations
65+- Use rule context to maintain coding standards
66+- Reference specific rules when making recommendations
67+- Apply rule principles in code suggestions and reviews
68+
69+## Contributing to Rules
70+
71+### Adding New Rules
72+1. Create a new `.mdc` file in this directory
73+2. Include proper metadata headers with description and globs
74+3. Write clear, actionable guidelines with examples
75+4. Test the rule with relevant file patterns
76+5. Update this README if needed
77+
78+### Updating Existing Rules
79+1. Modify the rule content while preserving metadata
80+2. Test changes with affected file patterns
81+3. Ensure consistency with other rules
82+4. Update examples and best practices as needed
83+
84+## Rule Format Reference
85+
86+Each rule file uses the MDC format with metadata:
87+
88+```markdown
89+---
90+description: Brief description of the rule's purpose
91+globs: ["**/*.ts", "**/*.tsx"] # File patterns for auto-attachment
92+alwaysApply: false # Whether to always include this rule
93+---
94+
95+# Rule Title
96+
97+Rule content in Markdown format...
8798 ```
99+
100+## Migration from Legacy Format
101+
102+The rules have been migrated from the legacy `.md` format to the modern `.mdc` format, providing:
103+- Better context awareness through file pattern matching
104+- Improved organization with metadata headers
105+- More flexible rule application strategies
106+- Enhanced integration with Cursor's AI features
107+
108+For the most up-to-date version of these guidelines, always refer to the files in this directory.
