What's new? | Help | Directory | Sign in
Google
                
Search
for
Updated Nov 26, 2007 by ospoadmin
HowToWriteTasks  
Tips for writing a good GHOP task.

Many thanks to Drupal for writing these guidelines.

Guidelines

  • The goal of GHOP is to get students interested and involved in open source, not to get free child labour. ;) The tasks should reflect that. Try and form your tasks around ideas that are fun, interesting, of high importance for the project, and/or would look great on a college application.
  • Each task should take a student approx. 2-5 days to complete, in between normal school work. If you have a great task idea, but it's going to take longer than that, consider turning it into a research task which can then be handed off to the larger community for execution.
  • Tasks don't need to be limited to coding! Tasks can be pretty much anything, including QA, marketing, design, usability, documentation, research...
  • Avoid "wildcard" tasks like "go fix any bug in the queue." You only have 102 slots available, so ensure that they're put against specific goals that you as a project require.
  • For coding tasks, it's safe to assume some level of C# or other .NET language knowledge. But remember that most of the students probably have not heard of Mono, or if they have, they're probably not familiar with its underlying APIs. So make sure to allow enough time for them to come up to speed (with help) and still get the task done.
  • Each task needs to make it clear exactly what you're looking for, which includes a detailed description of what the work entails and a clearly-defined deliverable. It also should include references to existing documentation specific to the task, unless this information is already covered in the Wiki (coding standards, etc). This helps students not waste time spinning their wheels looking for information, and helps ensure their efforts meet your expectations, leading to a more positive experience all around. :)
  • Once a task is entered, it cannot be edited, so make sure you get all the spelling and such right the first time around. ;)

Task template

Task title A short description of what the task entails

Task description Consists of:

An initial sentence or two that describes what the task entails and why a student would want to spend their time on it (emphasize importance to project, transferable skills...).

Several sentences/bullets that provide more detail into the task: What approach should students use? What level of detail are you looking for?

A sentence about what the expected deliverable is (a tutorial reviewed by at least one member of the documentation team and posted to the handbook, a patch in the core issue queue marked ready to be committed...)

Resources Bulleted list of resources specific to the task. This includes handbook pages, off-site resources, IRC channels, related groups on groups.drupal.org, etc.

Estimated time A "day" range of how long you think the task will take to complete, bearing in mind factors mentioned in the guidelines.

Primary contact The person we should list as the "owner" of the task, who will monitor student submissions and give the final sign-off. This should be either you or someone who you've talked to about taking this on.



Sign in to add a comment