Rules to organise the process of Checking in and out of TFS is vital for preserving the integrity of our solution.
This list is by no means fool-proof and exhaustive and hence any suggestions are welcomed and encouraged.
- Before Checking In or Out:
- Consider getting latest.
- Check if someone else has already checked the file out. If so, inform that person. This to avoid duplicating activities.
- Checking out:
- You can check out a file either explicitly by right clicking and select Check-out or implicitly by typing into the file.
- Before Checking-Out, check that the file is already checked out by another person; if so, inform that user, this to avoid duplicating activities.
- Checking In:
- Before checking in make sure:
- The modified code compiles.
- The entire solution builds successfully.
- StyleCop rules implemented.
- Code reviewer is present.
- Add clear and concise description to what has been changed and why.
- Assign to Work Item(s) ID
- Code reviewer name entered.
- Never Auto-Merge; always merge manually.
- Check that all new files, or relevant assembly in the global Library folder, have been successfully added to TFS. Missing such files might trigger Build Server failure.
- Before checking in make sure:
- After checking in keep an eye on the Build Server notification for successful build.
- At the end of the working day; if the coding is not successfully completed, you must “Shelf” the files within TFS.
- Make sure to regularly update relevant work items with progress and relevant comment.