Comments - Do you enforce comments with check-ins?
15/07/2014 11:09 AM by
Team Foundation Server is great, and one of its neat features is enforcing comments when checking in code. Without comments, some of the other built in features like History become redundant without comments.
You should have good comments… if you are struggling use this.
Figure: Bad Example: No Comments against the check-ins we don’t know what changes were made in each revision
Figure: Good Example: Now we can pin point which revision a particular change has been made
In Visual Studio 2013, to enforce this behaviour, you will need to:
Figure: Go to Team Explorer | Source Control
Figure: Then Check-in Policy | Add
Figure: Then select Changeset Comments Policy and OK
Figure: Now you have the Changeset Comments Policy applied to your Team Project
Now the next time someone checks-in some code, they are forced to enter a comment.
Do you feel this rule needs an update?