kris/afv-library
1
0
Fork 0
mirror of https://github.com/forcedotcom/afv-library.git synced 2026-08-09 08:53:18 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

added naming convetions and custom metadata rules

Browse Source
This commit is contained in:
Ashwin Gadhave 2025-11-13 16:23:53 +00:00
parent a522c422e0
commit 6b736337aa
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
rules/apex-development/apex-requirements.md
View File

@ -33,6 +33,20 @@ tags: apex, rules, guardrails, testing, security
- Use indexed fields in WHERE clauses when possible - Use indexed fields in WHERE clauses when possible
- Implement SOQL best practices: LIMIT clauses, proper ordering - Implement SOQL best practices: LIMIT clauses, proper ordering
- Use `WITH SECURITY_ENFORCED` for user context queries where appropriate - Use `WITH SECURITY_ENFORCED` for user context queries where appropriate
- When querying Custom Metadata Types (objects ending with `__mdt`), DO NOT use SOQL queries. Instead, use the built-in Custom Metadata Type methods like '.getAll().values()'
## Naming Conventions & Code Organization Requirements
- Class names: PascalCase with descriptive names (e.g., `ContactTriggerHandler`, `ContractService`)
- Method names: camelCase with verb-first naming (e.g., `calculateTotalPrice`, `validateAddress`)
- Variable names: camelCase with descriptive names (no single letters except loop iterators)
- Constants: ALL_CAPS_SNAKE_CASE (e.g., `MAX_RETRY_ATTEMPTS`, `DEFAULT_TIMEOUT`)
- Test classes: Append `Test` suffix (e.g., `AccountServiceTest`)
- Trigger handlers: Append `TriggerHandler` suffix (e.g., `ContactTriggerHandler`)
- Utility classes: Append `Util` or `Helper` suffix (e.g., `DateTimeUtil`, `ValidationHelper`)
- Prefix test methods with `test` or use `@IsTest` annotation
- Group related classes in packages/folders when possible
- Keep classes focused on single responsibility (SRP)
- Limit class size to 500 lines of code maximum
## Security & Access Control Requirements ## Security & Access Control Requirements
- Run database operations in user mode rather than in the default system mode. - Run database operations in user mode rather than in the default system mode.