-
Notifications
You must be signed in to change notification settings - Fork 27
Challenge Style Guide
All challenges require a title. The title is a string that must be no longer than 128 characters. The title is what is used for identifying a challenge. It should be short (three or four words should be sufficient) and generally self-explanatory.
When there are several challenges querying for the same situation but differ only by bounding polygons, the name of the polygon should be appended to the name of the challenge.
Challenges should also use "Headline Titles". In English, this means that each word (or major word) should be capitalized".
Good Challenge Titles
"Zoro Ways - United States" "Zoro Ways - Canada" "Crossing Roads"
Bad Challenge Titles
"Challenge 10" "Map validation errors"
When the challenge has a bounding polygon, the challenge should
All challenge require a unique identifier, in this case, a slug. From the Django documentation on slugs, "A short label for something, containing only letters, numbers, underscores or hyphens."
In Maproulette, slugs must be 72 characters or less in length. By convention, they should also be all ASCII characters, and all lowercase.
The slug for a challenge should generally match its challenge title in a meaningful way. For challenges which are bound, it's suggested that the geography be placed at the end of the slug.
Good Slugs
"zoro-us" "zoro-ca" "xing-roads"
Bad Slugs
"chal10" "map_validation_errors"
Every challenge should have a blurb. A blurb is a short, one sentence description of the challenge that is useful to quickly explain what the challenge is about.
It should generally follow the human readable guidelines.
Good Blurbs
"Roads which cross one another but appear disconnected" "Roads which have a kink in the road that looks like a Z"
Bad Blurbs
"This challenge contains road which cross one another but are not on the same level. This might include bridges, tunnels, or other situations which cannot be accounted for automatically."
"Validation errors"