Source Control#
The following table outlines the various files in a Studio 6 project and indicates whether each should be placed under source control.
File / Folder | Purpose | Place under source control? | Comments |
|---|---|---|---|
| Main project metadata configuration files. | Yes | |
| Contains shortcuts to highlighted source files or configuration tools. | No | The file will be recreated, and the available shortcuts are tailored to the individual user. |
| Contains configuration header files for the installed software components and subfolders for the Advanced Configurator (AC) files. For example, Bluetooth projects may include a | Yes | These files cannot be regenerated; their contents are not stored in the project configuration files (e.g., |
| Contains files generated by the Project Configurator based on the installed software components and the files in the | Depends on team workflow. If CI builds are performed without Simplicity Studio or slc, these files should be source controlled. | |
simplicity_sdk_x.y.z | Necessary SDK source files created by the Project Configurator based on the installed components. Recreated during project generation. | Same as | Files can either be links to actual files in the SDK or copies of the files from the SDK, depending on the import mode of the project. |
| VS Code extension integration files. Provide VS Code with tool version and basic project configuration information. Recreated during project generation. | Same as | |
| Files generated by the VS Code extension during a build. The | No | |
| Folder and files created during Project Configurator generation. | Most files are regenerated and should not be modified. | For information wabout which CMake files you can make changes to, see Additional Information about CMake Files. |
Build output folders under the | Created when the project is built. | No (unless binary files are required for production). | |
| Files created by the post-build generator | No (unless binary files are required for production). | |
| Project documentation files | No | These files can be updated to share project information. Updated versions should be source controlled. |
| Contains configuration files that were modified from default values before the component was removed by user action or an SDK upgrade. | No (unless the user wants to be able to roll back changes independently of source control). | |
| Files that keep track of changes made with the software component editors | No |