Codenarc integration review tracker

A PR has been created which contains large number of low-risk changes. (Codenarc integration by gilPts · Pull Request #517 · apache/ofbiz-framework (github.com))

Changes are consider low-risk as they modify OFBiz sources to comply with various Codenarc rules.

Although changes are low-risk, committers should still review the changes before the PR is merged with trunk.

Given the large number of changes, it will be useful to share the review effort among multiple committers. This page is intended to track that review effort since there doesn't appear to be a way to individually track reviewed files in GitHub.

Lifecycle for this page

This page is intended to be a temporary resource to assist OFBiz committers in reviewing PR 517 (Codenarc integration by gilPts · Pull Request #517 · apache/ofbiz-framework (github.com))

The page should be deleted (or archived) once the PR merge is complete or if this page turns out not to be helpful in tracking the review effort.

Review approach

Reviewers are asked to visit the PR and assess changed individual files.

If in the reviewers opinion a file change will not change OFBiz behaviour in any way they should mark the corresponding entry in the table below as PASSED.

If the reviewer identifies an issue with a changed file, then they should add a comment in the PR on GitHub AND mark the corresponding entry in the table below as WORK NEEDED.

If the reviewer is unsure how to classify a changed file they should mark the corresponding entry in the table below as UNSURE.

In each of the above cases, the reviewer should add their name against the entry in the table below.

Once any issue highlighted by a WORK NEEDED or UNSURE mark has been addressed to the satisfaction of a reviewer, that reviewer should change the mark in the table below as PASSED. Note that any reviewer can do this. It does not need to be the same reviewer that originally highlighted the concern, however if the concern was complicated it would be prudent to get the original reviewer's feedback.

If you make comments in the PR as part of a review, remember to submit the review frequently so that others can see and respond to your comments.

Table creation method

The table below was created by using the following command to identify all files changed in the PR:

# Checkout the PR
gh pr checkout 517

# See how many files have changed in the PR. Check against the number listed on GitHub
git diff --naname-only 88a014296c0fe7ec1d010bfb836595003aef14c0 HEAD | wc -l

# Save list of changed files to a temporary file, pr-files.
#  88a014296c0fe7ec1d010bfb836595003aef14c0 is the commit hash from where the PR was branched.
git diff --name-only 88a014296c0fe7ec1d010bfb836595003aef14c0 HEAD > pr-files

The pr-files file was then imported into Excel. The table was then copied and pasted into Confluence.

Reviewed files table

Copy and paste the following lozenges for the Review column:

PASSED

UNSURE

WORK_NEEDED

WIP