Configure check-in notes
TFS 2017 | TFS 2015 | TFS 2013
Administrators of Team Foundation version control can add, configure, and remove check-in notes. Check-in notes settings are set in the Source Control Settings window. For more information about check-ins, see Develop code and manage pending changes.
Prerequisites
To complete this procedure, you must have the Edit project-level information permission set to Allow. For more information, see Default TFVC permissions.
To add check-in notes
- On the Team menu, click Project Settings, and then click Source Control.
- In the Source Control Settings dialog box, choose the Check-in Notes tab, and click Add.
- In the Add Check-in Note dialog box, in the Title box, either type the desired name (for example, Documentation Reviewer), or select an existing check-in note from the drop-down list.
- If you want the note to be mandatory for check-ins, select the Required on check-ins box.
- Click Add, to return to the Check-in Notes tab in the Source Control Settings window with the new check-in note title added.
To configure a check-in note as being required
- On the Team menu, click Project Settings, and then click Source Control.
- In the Source Control Settings dialog box, click the Check-in Notes tab.
- In the Required column, select the check-in notes that you want to designate as mandatory, and clear those that you do not want to designate as mandatory for the check-in process.
To rename a check-in note
- On the Team menu, click Team Project Settings, and then click Source Control.
- In the Source Control Settings dialog box, click the Check-in Notes tab.
- Select the check-in note that you want to rename, and type a new name for it.
To change the ordering of the check-in notes
- On the Team menu, click Team Project Settings, and then click Source Control.
- In the Source Control Settings dialog box, select the Check-in Notes tab.
- Select the check-in note for which you want to change the order.
- Use the up and down arrow buttons to move the note to the desired order.
- Repeat process until all the check-in notes are in the order you desire. This ordering is reflected during the check-in process. For more information, see Using the Check In and Pending Changes Windows and Develop and share your code in TFVC using Visual Studio.
To remove check-in notes
- On the Team menu, click Team Project Settings, and then click Source Control.
- In the Source Control Settings dialog box, click the Check-in Notes tab.
- Select the check-in note title that you want to remove, and click Remove.