Rosetta Code:Add a Task: Difference between revisions
Content added Content deleted
Thundergnat (talk | contribs) m (→Basic information: Add son (rather stilted) verbiage about wordlists) |
Thundergnat (talk | contribs) (→Create the page: Formalize a few guidelines for task titles) |
||
Line 10: | Line 10: | ||
===Create the page=== |
===Create the page=== |
||
Come up with a title for your task (look at [[:Category:Programming Tasks|the current tasks]] to see what kind of name you should choose), type it in the search bar, and click "Go". There will be a "Create page" link on the resulting page somewhere. Click that, and you can begin editing. |
Come up with a title for your task (look at [[:Category:Programming Tasks|the current tasks]] to see what kind of name you should choose), type it in the search bar, and click "Go". There will be a "Create page" link on the resulting page somewhere. Click that, and you can begin editing. |
||
A few guidelines for a good task title: |
|||
* Don't be too general; make the title closely focused on describing what the task is actually asking to do. |
|||
::If your task is "Generate the lyrics to 99 bottles of beer" for instance, a good title is "99 bottles of beer". A poor title would be "Generate song lyrics". |
|||
* Don't be too specific; don't include terms that are peripheral to the task, even if it is a common term. |
|||
::If your task is "Generate twin primes up to some limit"; a good title is "Twin primes", a poor title would be "Twin prime conjecture". |
|||
* Follow some simple capitalization rules: |
|||
:# The first character of the title should always be uppercase, even if referring to something normally lowercase. |
|||
:# The first character after a level separator ( forward solidus: / ) should always be uppercase. |
|||
:# Every other word should be lowercase except for proper nouns, names and common initialisms. |
|||
:# Avoid including characters outside of ASCII alphanumerics. Try to make your task title easily type-able on a standard US keyboard. |
|||
There is substantial leeway in these rules, and some are subject to interpretation, but the closer you can come to following them, the easier it will be all-around. |
|||
===Draft vs non-draft=== |
===Draft vs non-draft=== |
||
Not all tasks are immediately ready to be thrown at the casual Rosetta Code participant. Some need a review or draft phase before they're in good shape. |
Not all tasks are immediately ready to be thrown at the casual Rosetta Code participant. Some need a review or draft phase before they're in good shape. |