Checklist API provides a simple interface for modules to create fillable, persistent checklists that track progress with completion times and users. It is intended to provide a common base for modules like SEO Checklist and QA Checklist to ensure quality and consistency in their implementations and to free them to focus on business questions (i.e. what goes in their checklists) instead of implementation details. See the included checklistapi_example.module for an example implementation.

My reviews of other projects:

CommentFileSizeAuthor
#4 Screen shot 2012-05-08 at 10.50.16 AM.png74.74 KBscarer

Comments

traviscarden’s picture

Note: PAReview gives two warnings:

FILE: ...ew_temp/test_candidate/checklistapi_example/checklistapi_example.module
--------------------------------------------------------------------------------
FOUND 0 ERROR(S) AND 2 WARNING(S) AFFECTING 2 LINE(S)
--------------------------------------------------------------------------------
  8 | WARNING | Line exceeds 80 characters; contains 98 characters
 10 | WARNING | Line exceeds 80 characters; contains 98 characters
--------------------------------------------------------------------------------

They refer to @link ... @endlink code, which as I understand should be all on the same line and is permitted to exceed 80 characters. I can't find this fact documented anywhere at present. I'll have it confirmed and then see if I can't get it noted in the standards. Then I'll put in an issue to update the Code Sniffer accordingly. Update: This has been confirmed to be a false positive. See #1559536: False positive/Support @link...@endlink standards.

traviscarden’s picture

Issue summary: View changes

Updated issue summary.

patrickd’s picture

welcome,

As installation and usage instructions are quite important for us to review, please take a moment to make your project page follow the tips for a great project page.

You can retest your coding standards with http://ventral.org/pareview or even install it on your own computer.

We do really need more hands in the application queue and highly recommend to get a review bonus so we can come back to your application sooner.

regards

traviscarden’s picture

Issue tags: +PAreview: review bonus

Adding tag.

scarer’s picture

StatusFileSize
new74.74 KB

I had a look through the code and it looks clean.

I passed the branch through Ventral and there's a couple of lines that exceed 80 characters: http://ventral.org/pareview/httpgitdrupalorgsandboxtraviscarden1552420gi...

I installed the module and looked at the output from the example. The vertical tabs are displaying a bit funny. I tried this in two of the default Drupal 7 themes. See attached screen shot.

traviscarden’s picture

Thank you, @scarer.

The PAReview errors are false positives. See #1.

Vertical tabs always display that way in Bartik; it's not a function of my implementation.

targoo’s picture

Hi

manual review:

1) Your using variables -> you got to remove them on hook_uninstall with variable_del()
Run a db_delete() against the variable table with LIKE checklistapi_checklist_%.

Best,

traviscarden’s picture

Thank you, @targoo. I thought about that, but the variables won't belong to the API—they'll belong to the implementing modules. If I take responsibility for removing them in checklistapi_uninstall() they may not always be properly removed. For example, suppose foochecklist.module and barchecklist.module both implement the API. If a user installs and uses both and then only uninstalls foochecklist.module, the API won't be uninstalled, so checklistapi_uninstall() won't be executed and foochecklist.module's variables won't be deleted. If you have a good solution for this, I would most gladly hear it. Otherwise, maybe I just need to add a note to the documentation that it's the responsibility of implementing modules to delete their own variables on hook_uninstall().

klausi’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: -PAreview: review bonus

Looks good to me. Removing review bonus tag, you can add it again if you have done another 3 reviews of other projects.

targoo’s picture

indeed. A note should do the trick then.

patrickd’s picture

Status: Reviewed & tested by the community » Fixed

Nice one!

Thanks for your contribution and welcome to the community of project contributors on drupal.org!

I've granted you the git vetted user role which will let you promote this to a full project and also create new projects as either sandbox or "full" projects depending on which you feel is best.

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

As you continue to work on your module, keep in mind: Commit messages - providing history and credit and Release naming conventions.

Thanks to the dedicated reviewer(s) as well.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

Anonymous’s picture

Issue summary: View changes

Updated issues ummary.