The task is review the different components of the 'examples for developers' module, and provide results about the efectivity of the example to demonstrate and learn its own API (each example component covers a single Drupal API in most of the cases), considering only Examples for developers module and api.drupal.org site as documentation sources.

An student with php programming skills without Drupal programing knowledge is prefered.

Preparation and task list

  • Get a copy of Drupal and "examples for developers" module and install them.
  • Go through each one of the examples component and perform the following review
    • Verify that code is readable
    • Verify that each different API function is explained enough and no additional resources are required to understand it
    • Verify that documentation in api.drupal.org Matches the documentation in the example module.
    • Review the testcase included as additional documentation
    • Attempt to reproduce the API with a different usage (e.g. create a custom form with different submit handlers, create an xml-rpc server with custom functions, ..)

Deliverables

The student should fill an issue in the issue queue for each 'examples for developers' component with the following conditions:

  • An abstract about the learning and understanding dificulty of the component
  • Detail what was found confusing or not clear enough from a first review
  • Detail differences between API documentation and module documentation if found
  • Detail any missing part or documentation detected in the component if found
  • Attempt to find another usage of the example status: success or failure

Resources

http://code.google.com/p/google-highly-open-participation-drupal/wiki/Fu...

Examples project at drupal.org: http://drupal.org/project/examples
Drupal API site: http://api.drupal.org/api/7
Doxygen formatting conventions: http://drupal.org/node/1354
http://drupal.org/coding-standards

Primary Contact

Charlie Gordon, ( cwgordon7 on irc or http://drupal.org/user/157412/contact form)

Could mentor: ilo

Comments

ilo’s picture

ilo commented
Status: Active » Needs review

I forgot to set as NR.

vosechu’s picture

vosechu commented

I'm concerned that the student may not be able to evaluate code quality. They can certainly try it out and see what happens (which is valuable), but the title indicates more. Maybe we just need a title change to something like 'Examples for Developers effectiveness review'?

cwgordon7’s picture

cwgordon7 commented

What's the difference between this idea and your other related ideas? There seems to be a lot of overlap, and I'm not sure these lend themselves well to being GCI tasks.