Tools and methods for code review (VHDL, Visual Studio / TFS)

Go To Last Post
3 posts / 0 new
Author
Message
#1
  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

I have realized that the code review process at my current workplace could need some better tools and methods.

 

We use TFS (Team Foundation Server) for version control and typically do a diff between two changesets when it's time to review (usually for an upcoming release). The differences can thus be quite extensive. Optionally one can do review per changeset which is in some ways better but OTOH might be a bigger effort since some changesets may cancel out or overwrite one another so to speak.

 

The source code is VHDL.

 

The review results in a table of items to fix. This is kept separately in an Excel sheet and discussed at a meeting.

 

What I feel is missing or should be improved is:

  • a better way to generate and hand over the basis for the review, e.g. some kind of HTML report with changes listed as separate items together with changeset log message (and possibly other info) so that the review process is simply a matter of looking through a set of X items that are clearly defined from the start. I think that proper syntax highlighting in the report would be very beneficial (this may be difficult to achieve since it is VHDL code).
  • an easier way to do informal reviews and changes without having to sit down in a meeting (typically most changes are accepted by the participants)

 

Does any of you have any suggestions for tools & methods for this?

 

(BTW I have never used the built-in code review feature of Visual Studio so it's possible that it would be sufficient)

 

 

 

 

 

 

/Jakob Selbing

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

One word: Gerrit

(having said that, github also allows for peer review gates on pull requests too)

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

jaksel wrote:
(BTW I have never used the built-in code review feature of Visual Studio so it's possible that it would be sufficient)
fyi, VHDL extensions :

Search results - VHDL | Visual Studio , Visual Studio Marketplace

 

GitLab though integration is more complete with Visual Studio Code.

GitLab 8.12 Released with Cycle Analytics and Global Code Search | GitLab

[mid-page for VHDL]

Expanded syntax highlighting

 

"Dare to be naïve." - Buckminster Fuller