SugarCRM 25 Development Best Practices
Procedural knowledge for developing and customizing SugarCRM version 25 (Sugar 25.x). Use this skill when writing or reviewing Sugar customizations, new modules, logic hooks, Sidecar UI, REST integrations, or MLPs.
When to Apply
- Customizing Sugar (new fields, modules, layouts, or business logic)
- Writing PHP logic hooks, API integrations, or backend code
- Building or extending Sidecar (Backbone.js) views and components
- Designing or packaging Module Loadable Packages (MLPs) or Marketplace add-ons
- Reviewing code for upgrade safety, security, or policy compliance
- Integrating with Sugar via REST API or headless access
Quick Principles
- Prefer configuration and extension over core edits — Use Studio, logic hooks, and MLPs; never persist changes in core
modules/,include/, or core Sidecar assets. - Target Sidecar for UI — Sugar 25 uses the Sidecar (Backbone.js) client; build new UI there and use versioned Sidecar API and DB Schema for your 25.x release.
- Package with MLP for distribution — Use Module Loadable Packages for installable, upgrade-safe customizations; follow Marketplace Package Guidelines if publishing.
- Stay on supported platforms — Use Supported Platforms for your 25.x release (PHP, DB, OS).
- Follow Developer Policy — No forking, no prohibited licenses (e.g. GPL/AGPL), no stripping Critical Control Software or Sugar notices; respect Developer Policy and SugarCloud Policy when applicable.
Reference Sections
For detailed rules and examples, read as needed:
| Topic | File | Use when |
|---|---|---|
| Architecture & platform | references/architecture.md | Choosing stack, Sidecar, MLP, supported platforms |
| Customization | references/customization.md | Studio, logic hooks, REST API, Sidecar UI, upgrade safety |
| Code standards | references/code-standards.md | PHP/JS conventions, security, upgrade-safe patterns |
| Developer policy | references/developer-policy.md | Policy, IP, SugarCloud, Marketplace/MLP requirements |