Skip to content

Scribe Home

Imperadeiro98 edited this page Jul 1, 2015 · 9 revisions

Programming and code aren't the only languages we use at CodeCombat — the written word makes our app easy to understand, fun to play, and a joy to contribute to. For these important tasks, we lean on our Scribes.

####How to Become a Scribe

  1. Head over to the Scribe Page on the main website.
  2. Click the "Contact Us" link to open a popup contact form.
  3. Tell us a little about yourself, your experience with programming and what sort of things you'd like to write about. We'll go from there!

Please note, we'll need to have you sign our Contributor Licence Agreement before your changes are merged. We also suggest you use Direct CodeCombat while contributing.

####What Scribes Can Work On If you're ready to flex your writing skills, here are the places where we can use your help the most:

  1. Each level has a guide with some level-specific tips and tricks in it. We want to make sure these guides nudge folks along, but keep the game challenging. Take a look through the existing guides and see if they make sense, especially to someone who is learning to code. As we create new levels, we need to write new guides for them, too. (Example)

  2. Article writing more your thing? Contribute by helping us teach a programming languages and concepts, so that when a concept is used in a level, we can pull in that article into a tab in the Guide. (example)

  3. Each player-accessible method and property has its own documentation, which often doesn't get enough love and isn't written beginner-friendlily. We'd love to have those level up. (example)

  4. Each level, item, and hero has a short description associated with it. Too often we're too focused on just building these things to do a good job on the copywriting. We really need a pass over these to add great descriptions to things. (example level, example item, example hero and editor)

  5. General website / community / contribute copy improvements. (example)

  6. Keeping our FAQ simple and easy to understand.

  7. Organizing, editing, and contributing content to our GitHub wiki.

####How to Modify Content on the General Website We maintain all the content on the website through GitHub. There are two ways to contribute:

  1. Set up the dev environment on your computer, so you can test your changes locally. (Recommended)

  2. Make edits in the GitHub web interface, and a member of the core team will test your changes to make sure they work.

####Sample Workflow Let's say you wanted to update the adventurer character class copy. You'd follow this process:

  1. Find the template you want to use by following the directories here: https://github.com/codecombat/codecombat/tree/master/app/templates -> this would eventually lead to /app/templates/contribute/adventurer.jade.

  2. Make your changes to the copy. You can check out http://jade-lang.com/ for a reference on how it works, but it's basically super-compactified minimalist HTML.

  3. Update our base localization file, app/locale/en.coffee, to add or update any localization keys you created or changed in the template. If the text change is large, it's best to change to a new key and delete the old key, so that the Diplomats know to translate it into our 45+ languages. Otherwise, if the change is small, you can just update the existing key's text, and it'll change in English and still be translated in the other languages, but they might not notice and update it for most of them.

Let's say you wanted to update this text:

 p(data-i18n="contribute.adventurer_introduction")
     | Let's be clear about your role: you are the tank. You're going to take heavy damage.
     | We need people to try out brand-new levels and help identify how to make things better.
     | The pain will be enormous; making good games is a long process and no one gets
     | it right the first time.
     | If you can endure and have a high constitution score, then this class might be for you.

And you want to change it to this:

 p
     span.spr(data-i18n="contribute.adventurer_introduction_prefix") You get to playtest new levels early, and stuff. We introduce new levels weekly, and then you give us feedback on
     a(href="http://discourse.codecombat.com", data-i18n="play.adventurer_forum") the Adventurer forum
     span(data-i18n="contribute.adventurer_introduction_suffix") , which really helps us so much a lot thanks to you!

That would translate into this HTML:

 <p>
     <span class="spr" data-i18n="contribute.adventurer_introduction_prefix">You get to playtest new levels early, and stuff. We introduce new levels weekly, and then you give us feedback on</span>
     <a href="http://discourse.codecombat.com" data-i18n="play.adventurer_forum">the Adventurer forum</a>
     <span data-i18n="contribute.adventurer_introduction_suffix">, which really helps us so much a lot thanks to you!</span>
 </p>

except with no whitespace in it that wasn't explicitly in the .jade template. To keep the link from mashing with the prefix, the ".spr" (space-right) class is used.

####How to Make Sure Your Content is Translated into Other Languages CodeCombat is available in over 45 languages. If you don't speak them all, don't worry! Use this process and our Diplomats will help make sure your content gets translated properly.

We added two localization keys (contribute.adventurer_introduction_prefix and contribute.adventurer_introduction_suffix) and reused one we found elsewhere in en.coffee (play.adventurer_forum), so we'd go to app/locale/en.coffee add those two and delete the contribute.adventurer_introduction key.

####Merging Your Changes Follow these steps and you'd be good to go–new copy with brilliant wordsmithery! After committing your changes and pushing them to your fork, create a pull request with the GitHub web interface.

Clone this wiki locally
You can’t perform that action at this time.