Form like information in Jira issue

[Mike Zielinski]

I've been asked to incorporate a code review checklist into an issue type and I'm wondering how best to go about this.  I'd like to require that all stories answer the following before moving out of review and am looking for the best way to capture the information, most are simple Yes/No/NA questions but some require comments.  We were thinking of creating a tab on the issue and adding custom fields for each question but this seems cumbersome.  Do you have any suggestions about an efficient way to handle this ?

---

Update the Jira issues to include a Code Review checklist section that must be completed before moving an Issue to Review.  Once the developer has completed filling in the fields, the review must also verify the fields are correct.

---

Development / Coding

1. Coding standards followed and correct formatting applied?
2. Comment blocks added to describe new/changed methods, classes, and logic?
3. Ensure there are no dependency violations? (i.e. use NetBeans or Lattix to check dependency changes)
   • Conversely, ensure that a dependency added actually makes sense.
4. Ensure there are no extraneous files checked in that do not apply to this Issue
5. <JAR version updates??>

---

10x Service Maintenance Tasks

1. Added/removed/renamed a field in the domain model?
   1. Search fields updated in domain model's getDomainModelMap method?
2. Added/removed/renamed a service and/or service operation?
   1. Application Configuration Updated?
   2. Deployment Descriptors Updated?
   3. Public Service API Documented?
   4. Web Client Project pom Updated?
3. JAR files in the lib directory added, changed, or removed?
   1. SWAP request added to Products in Jira and approved by Information Assurance team?
4. Updated version notes with change?

---

Conditional Maintenance Tasks

1. Modified start-menu shortcuts (add/remove/rename/move)?
   1. Shortcut paths updated in the InstallShield project?
2. Added/removed/renamed a property or changed a property comment?
   1. Updated the property upgrader for current release?
3. Changes included a DB upgrade?
   1. Completed all steps in DB upgrade document?
4. Were any Icons added or removed?
   1. Were the Icons added/removed to/from the proper project (ImageResources for Desktop)?
5. Were UIs added, updated, or removed?
   1. Do the UIs follow the UI Style Guide?
6. DLL or EXE files in the bin directory added, changed, or removed?
   1. SWAP request added to  Products in Jira and approved by Information Assurance team?
   2. Readme.txt file in corresponding directory updated?
7. JAR files in the lib directory added, changed, or removed?
   1. SWAP request added to  Products in Jira and approved by Information Assurance team?
   2. Readme.txt file in corresponding directory updated?
   3. Build.xml file (used for nightly builds) updated?
8. Was refactoring done that modified file or class names or locations?
   1. Updated Logging Presets?
   2. Updated Install Checker file?
9. Were any ports or protocols added, changed or removed?
   1. Updated port usage help document
   2. Updated port usage Visio diagram?

1. Netbeans module(s) were modified (This really needs to be in a flow chart)
   1. POM file version(s) incremented to next release version (Yes/Already at next release version/No)
      1. All modules that use the modified module now point to the incremented version (recurse changes)?

---

Documentation

1. Updated version notes with change?
2. Updated Feature Powerpoint file for release? (\docs\Feature Summary)
   • /help/help/docs/
3. Change affects system upgrade procedure? (i.e. property file or DB change)
   1. Install notes updated?
4. Impacted help documentation text or screenshots? (Incomplete or inaccurate?)
   1. Updated help document text? (MAAS\Dva\web\help)
      • Admin/help/ for service and /help/help) client
   2. Updated screenshots? (For UI changes)

---

Testing This section could be boiled down to: Does this issue require test, or will the test be covered in another story. If yes, are there test steps, if no, what story? There seems to be no reason for the distinction between fixed a problem and included an enhancement.

1. Development fixed a problem? (i.e. not strictly an enhancement)
   1. Steps to reproduce problem are documented?
   2. Test data is available to replicate the problem?
2. Development included an enhancement?
   1. Description of enhancement(s) and test procedure(s) documented?

[Nagy Orsolya]

Do you have any suggestions about an efficient way to handle this ?Comment blocks added to describe new/changed methods, classes, and logic?? There seems to be no reason for the ...., Products in Jira and approved by Information Assurance team",,