Configure check-in notes
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
Visual Studio 2019 | Visual Studio 2022
Team Foundation Version Control administrators can add, configure, and remove check-in notes by using the Settings for Source Control in Visual Studio Team Explorer. For more information about check-ins, see Develop code and manage pending changes.
Prerequisites
You must have the Edit project-level information permission set to Allow. For more information, see Default TFVC permissions.
To add check-in notes
- In Visual Studio Team Explorer, under Project, select Settings.
- On the Settings page, in the Team Project section, select Source Control.
- In the Source Control Settings dialog box, select the Check-in Notes tab, and then select Add.
- In the Add Check-in Note dialog box, enter a note Title, such as Documentation reviewer, or select an existing title from the dropdown list.
- If you want the note to be required for check-ins, select the Required on check-ins checkbox.
- Select Add. You return to the Check-in Notes tab with the new check-in note title added.
To configure check-in note requirements
- In Visual Studio Team Explorer, under Project, select Settings.
- On the Settings page, in the Team Project section, select Source Control.
- In the Source Control Settings dialog box, select the Check-in Notes tab.
- In the Required column, select the check-in notes that you want to be mandatory for the check-in process, and deselect the notes that you don't want to be mandatory.
- Select OK.
To rename a check-in note
- In Visual Studio Team Explorer, under Project, select Settings.
- On the Settings page, in the Team Project section, select Source Control.
- In the Source Control Settings dialog box, select the Check-in Notes tab.
- Select the check-in note that you want to rename, and type a new name for it.
- Select OK.
To change the order of the check-in notes
- In Visual Studio Team Explorer, under Project, select Settings.
- On the Settings page, in the Team Project section, select 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 at lower right to move the note to the desired order.
- Select more check-in notes and move them up and down until the check-in notes are in the order you desire.
- Select OK.
The check-in note 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
- In Visual Studio Team Explorer, under Project, select Settings.
- On the Settings page, in the Team Project section, select Source Control.
- In the Source Control Settings dialog box, select the Check-in Notes tab.
- Select the check-in note you want to remove, and select Remove.
- Select OK.