Table Of Contents

Recommendations for Developing a Project in a Distributed Source Code Control System

Last Modified: April 10, 2020

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

spd-note-note
Note

The following information uses terminology and commands from Git. However, you can apply these concepts when interacting with any distributed source code control provider.

Obtaining a Working Copy of a File and Making Modifications

Recommendation Details
Merge from the central repository 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.

Fetch and merge to update code in your local repository.

Commit files to your local repository often.

Commit to your local repository as often as you want. It is common to commit locally many times per day.

Committing and Pushing Files

Recommendation Details
Push all files with changes in the project folder.

Push any files with changes. Most source code control providers scan for changes to the project folder to help you identify changed files.

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, include the directories in a .gitignore file.

Refer to Git documentation for more information.

Add descriptive comments when you commit to your local repository or push to the central repository.

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


Recently Viewed Topics