Development Best Practices

We recommend some best practices to maximize development efficiency and results.

Instance Naming

An instance is a server connection path. Give your instance a unique name such as firstInitial_lastName to avoid multiple developers changing the same instance, which can result in code overwrite or code loss. A unique name also identifies which developer is working on an instance.

.zip Files in Code Repository

If you use .zip files to transfer code, we recommend that you unzip the files into the code repository. Otherwise, change tracking only affects the entire .zip file and not the individual files within it.

In our standard processes, cartridges are not saved in .zip files. However, some implementation partners can have implemented a process where they zip versioned cartridges for storage.

It's possible to export a site into a .zip file (Site Export functionality). That .zip file contains site configuration data and other data objects. Track the contents in the versioning system.

X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.