Click here to Skip to main content
Click here to Skip to main content
Technical Blog

Tagged as

Team Foundation Server Best Practices (1 of 3)

, 9 Nov 2013 CPOL
Rate this:
Please Sign up or sign in to vote.
Some best practices to help some minor learning curves and also a refresher for those of us that have been using it for years.
  1. What Should Be Checked In
  2. The Right Way To Check In
  3. Things To Watch Out For (coming soon)

Recently I have been on a few projects with developers that were not as experienced in using Visual Studio with Microsoft’s Team Foundation Server so I thought it was prudent to put together some best practices to help them over some minor learning curves and also as a refresher for those of us that have been using it for years. 

What should be checked in?

This may seem obvious but there are some things that you may not think of checking in that you should:

Solution/Project Files

your *.sln and *.csproj (and others) contain the list of every file that is in your solution/project.  If you just check in a folder of files on your screen it may look fine but when someone else goes to get your code they won’t see these files.

Nuget Packages

If you are not familiar with NuGet packages yet it’s well worth your time to look it up.  This was more of an issue with previous versions of Visual Studio but since they are not visible in the solution explorer and contain binary files (*.dlls) inexperienced developers may ignore them not realizing that these should be checked in

Scripts

Most projects that I deal with have some sort of scripts associated with them.  Things like scripting the setup of a new local environment (for new developers or getting a clean slate for existing ones) or deployment scripts (for upgrading an existing database schema to work with the latest version of your code). 

  • PowerShell
  • Batch Files
  • SQL
  • etc.

Documentation

Even though I like to keep documentation in a CMS like SharePoint it’s also very helpful to check it in with the rest of your code.  I most often do this when merging code into another branch because it’s nice to keep the doc that goes with a particular version tied to it in source control. 

  • Deployment Instructions
  • Technical Specifications

There are plenty of other things to make sure you have checked in but these are the big ones that I often see missed by old and new developers alike.

Look for the next part in this series “The Right Way to Check In”

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

JJ Bussert
Architect
United States United States
No Biography provided
Follow on   Twitter

Comments and Discussions

 
GeneralMy vote of 3 PinmemberKannan Karthikeyan28-Mar-14 5:20 
GeneralManaging Documentation PinmemberKlaus Luedenscheidt9-Nov-13 18:24 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.141216.1 | Last Updated 9 Nov 2013
Article Copyright 2013 by JJ Bussert
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid