W-21626262 Remove incorrectly placed warning to not add XML comments before the root element (#60)

Remove incorrectly placed warning to not add XML comments before the root element
This commit is contained in:
h-kapoor-sfdc 2026-03-18 12:07:19 +05:30 committed by GitHub
parent 58ff5530ae
commit 46686e231c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -42,10 +42,6 @@ Every generated field must include these tags:
| `<description>` | Mandatory | State the business "why" behind the field |
| `<inlineHelpText>` | Mandatory | Provide actionable guidance for the end-user. Must add value beyond the label (e.g., "Enter the value in USD including tax" instead of just "The amount") |
### XML Comments — NEVER Before Root Element
**NEVER place XML comments (`<!-- ... -->`) before the root `<CustomField>` element in metadata XML files.** Comments between the XML declaration and `<CustomField>` cause a `ConversionError` during deployment. Comments inside the root element are safe.
### External ID Configuration
**Trigger:** If the user mentions "integration," "importing data," "external system ID," or "unique key from [System Name]," set `<externalId>true</externalId>`.