Table Of Contents

Recommendations for Interacting with a Centralized Source Code Control System while Developing a Project

Last Modified: April 10, 2020

Learn how to interact with a centralized source code control provider while developing a project.

spd-note-note
Note

The following information uses terminology and commands from Subversion (SVN). However, you can apply these concepts when interacting with any centralized source code control provider.

Checking Out Files and Making Modifications

Recommendation Details
Lock VI files to prevent other developers from making simultaneous changes.

Locking VI files when you check them out reduces the chances of code-breaking merge conflicts.

Update your local copy of the project regularly during development.

Keeping your local copy of the project in sync with the central repository ensures you are developing code against the most recent version of the project.

In SVN, use the svn update command.

Exit LabVIEW NXG before updating your local copy.

If you leave LabVIEW NXG open when you update your local copy, it is possible to corrupt files in the project.

Checking In Files

Recommendation Details
Check in all files within the project folder that have changes.

You may notice that some files have changes even if you did not modify them. In particular, the project file will frequently change due to changes in other files.

Your source code control provider should scan the project folder for changes. Use this feature to identify all files with modifications.

Ignore the following directories when you submit to the central repository:
  • Builds
  • .cache

Changes within these sub-directories do not affect the functionality of source code in the project. The project directory in the central repository may already be configured to ignore the folders. If not, use the -global-ignores option in SVN.

Refer to SVN documentation for more information.

Add a descriptive comment to your commit.

Descriptive comments help you and other developers interpret changes you submit to the repository.

After you commit files to the repository, notify other team members.

Other developers may need to change their code based on changes you make.

Some collaboration tools, as well as some source code control systems, can auto-generate emails when changes to the repository occur.


Recently Viewed Topics