Documentation

gitHub

Submit for review

The peer review feature is a very popular collaboration extension to Git, supported by most of the repository hubs.  It allows changes made by a user to be submitted for review and approval by another user before being merged into a target branch.  

 

Changes to data models are proposed in a branch, to ensure that the target branch only contains finished and approved work.  Anyone with read access to a repository is allowed to submit changes for review.

 

Important: to be able to submit changes for review, you first need to connect to your repository hub.

 

Note:  the naming conventions differ slightly between repository hub providers.  GitHub, for example, uses the terminology pull requests, whereas GitLab uses merge requests.  Both refer to the same concept.  Hackolade Studio takes into account the specific terminology of the hub provider.  However, in this documentation, we abstract them and refer to the more generic "change requests".

 

A typical change process is to first checkout a new branch. then make the necessary changes, commit them, and push them.  This makes your new branch available in the remote repository.  Multiple changes can be made to a branch, and the change request applies to all the changes in that branch.  If you want to split changes in different requests, you should create a separate branch for each group of changes.

 

A branch is meant to be temporary: it should be reviewed, typically by another user, merged into a long-living branch, and ultimately deleted.  In order to initiate the review process, you need to submit your changes for review.  You can do it directly from Hackolade Studio.

 

 

Submit a change request

In the repository context, select as the active branch, the branch for which you want to submit a change request, then click on the left menu item "Submit for review" to get the screen below:

Workgroup submit for review

  • provide a title, a short description of the changes made;
  • optionally provide a more detailed description of the changes.  You can write that description using the Markdown syntax
  • select the target branch into which the changes must be merged.

 

 

Workgroup submit for review markdown

Hackolade lists all the commits to be included in the review.  You can self-review the changes in these commits before submitting them using the "Review changes..." button. It opens up the compare dialog and provides a graphical visualization of the changes.

 

You can then click on the "Open pull request" button to submit your changes.

 

Once your change request is opened, you get the screen below, displaying a link to open the change request in a browser if necessary.

 

Workgroup submit for review - submitted

 

Display change requests you submitted

In the left menu, the counter of change requests "open by me" reflects the number of open change requests. Clicking on it displays the list of change requests you authored.

Workgroup submit for review - open by me

 

You can click on the title of a change request to display a detail screen and check if you received feedback from reviewers. The change request detail screen is documented in the next page.

 

Note: it is not allowed to create more than one change request for a same combination of source branch and target branch.  However, nothing prevents you from making further changes while your change request is opened, and maybe being reviewed already.  You just need to commit and push your changes: and they will be automatically included in your change request and made available to the reviewer(s).