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

Merge pull request #2 from ashwingadhave/af-vibe-apex-requirement

Browse Source 
Naming conventions and Custom metadata SOQL rules
This commit is contained in:
Jeff Douglas 2025-11-14 16:04:34 -05:00 committed by GitHub
commit 003d847fa6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
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.
@ -66,7 +80,7 @@ tags: apex, rules, guardrails, testing, security
- Create test data using `@TestSetup` methods when possible - Create test data using `@TestSetup` methods when possible
- Mock external services and callouts - Mock external services and callouts
- Do not use `SeeAllData=true` - Do not use `SeeAllData=true`
- Test bulk trigger functionality - Test bulk trigger functionality.
## Test Data Management Requirements ## Test Data Management Requirements
- Use `Test.loadData()` for large datasets - Use `Test.loadData()` for large datasets