Hi,

I developed a scoreboard module for Closed Question questions. It's developed to be used in a learning environment where we want to provide both students and teachers with scoreboards.

Project link: http://drupal.org/sandbox/timcooijmans/1801114
Git clone: git clone http://git.drupal.org/sandbox/timcooijmans/1801114.git closedquestion_scoreboard

The module is Drupal 6 only at the moment as our environment is still Drupal 6 due to legacy issues.

Comments

jvdurme’s picture

Hi Tim,

First you better change the git clone code to:

git clone http://git.drupal.org/sandbox/timcooijmans/1801114.git closed_question_scoreboard

You forgot the module name, now it creates a folder called "1801114".

I ran your code through http://ventral.org/pareview/ and found following minor warnings:

FILE: ...l/modules/pareview_temp/test_candidate/closedquestion_scoreboard.module
--------------------------------------------------------------------------------
FOUND 0 ERROR(S) AND 6 WARNING(S) AFFECTING 6 LINE(S)
--------------------------------------------------------------------------------
42 | WARNING | Format should be "* Implements hook_foo()." or "Implements
| | hook_foo_BAR_ID_bar() for xyz_bar()."
57 | WARNING | Format should be "* Implements hook_foo()." or "Implements
| | hook_foo_BAR_ID_bar() for xyz_bar()."
64 | WARNING | Format should be "* Implements hook_foo()." or "Implements
| | hook_foo_BAR_ID_bar() for xyz_bar()."
129 | WARNING | Format should be "* Implements hook_foo()." or "Implements
| | hook_foo_BAR_ID_bar() for xyz_bar()."
144 | WARNING | Format should be "* Implements hook_foo()." or "Implements
| | hook_foo_BAR_ID_bar() for xyz_bar()."
151 | WARNING | Format should be "* Implements hook_foo()." or "Implements
| | hook_foo_BAR_ID_bar() for xyz_bar()."
--------------------------------------------------------------------------------

So the comment title should be e.g.

Implements hook_form().

Only when the part after "for" is a function, you can write it the way you wrote it. But "scoreboard_student" is not a function.
Other than that the code looks good and clean to me.

Some more things to be done before any official reviewer will accept the module:

Please include a README.txt file and format the README.txt file a little. Here are a few examples of README files: http://drupal.org/node/447604

To make your project more sexy, format the project page in sections, as e.g. mentioned here: http://drupal.org/node/997024. Definately list dependencies.

cu,

Joost

jvdurme’s picture

Status: Needs review » Needs work

Have to set it to needs work ;-)

dharam1987’s picture

Hello,

Apart from what jvdurme said, here are few manual reviews about your code.

1- Line no #78 in your module, make sure the table names are wrapped up using {tablename}, else your module is not going to work in the drupal instances whose tables are prefixed.

2- Make sure any text that is being output for the user are enclosed using t, ex - t('Wrong answers'), t('Answered correctly') at line #114

Thanks

timcooijmans’s picture

Status: Needs work » Needs review

Hi,

Thank you all for your comments. I've made the following changes:

  • Fixed git clone command on this page.
  • Fixed hook comments. The validator now runs without warnings.
  • A README.txt with all needed information was already in the repository. I added a link to the README.txt from the project homepage.
  • Updated the project homepage with more information and better layout.
  • Table names are now wrapped to support prefixed table names.
  • All text outputted to the user is now enclosed using the t-function.
jvdurme’s picture

Status: Needs review » Reviewed & tested by the community

Hi Tim,

code looks good to me, but I'm not an expert. I installed your module and its dependencies without problems.
I filled in a closed question and created a scoreboard afterwards.
Does exactly what I expected. No issues on the UI side.

RTBC for me.

timcooijmans’s picture

Hi,

Thanks. You might be interested in another module I will be releasing soon: An input-filter to show JMol and JSpecView applets in various node-types (including ClosedQuestion questions).

Tim

jvdurme’s picture

Aha, you do know I'm currently working on a Jmol file formatter (in final stage)? :-)

klausi’s picture

We are currently quite busy with all the project applications and I can only review projects with a review bonus. Please help me reviewing and I'll take a look at your project right away :-)

cubeinspire’s picture

Status: Reviewed & tested by the community » Fixed

Automatic review:
1. There are some minor code standard problems: http://ventral.org/pareview/httpgitdrupalorgsandboxtimcooijmans1801114git

Manual review:
2. The description inside the hook_node_info() should also pass through t() to allow translations.
lines 15, 21 of the dot module file.

As I see no blocker issues I guess this is RTBC.

Thanks for your contribution, timcooijmans!

I updated your account to let you promote this to a full project and also create new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and get involved!

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.

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 git clone to contain the right folder name