Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.89 KB

CONTRIBUTE.md

File metadata and controls

36 lines (25 loc) · 1.89 KB

Contribute


Code

If you can code Coffeescript, feel free to make a pull request. Make sure to check out my Zenhub board so we don't have any conflicts if I or someone else has already started on an issue. :)

Rules

  • Must pass all tests. npm test
  • Must write tests for all new functions (look at current tests for examples, still a WIP).
  • Functions must be camel cased. downloadStuff()
  • Variables must be underscored. my_champion = 'teemo'
  • PR must be off and back to master branch.

I suggest making sure your linters are setup correctly, or run gulp lint every now and again so you're not making a crazy amount of commits.


Translations

I use Transifex to manage all my translations, it's super easy and lets everyone contribute! The initial translations were done with Google Translate, so just because a translation exists doesn't mean it's correct.

Rules

  • Make sure to check if a translation has been done already before writing it over again.
  • If you have an issue with someone elses translation, please use the comments section.
  • Don't add extra punctuations (such as ...) to the end of translations if the English version doesn't have it.
  • Take a look at the screenshot links you'll find with each translation (if they're available), or check out the screenshot folder

Setup

  • Create an account with Transifex (Or login with Github/Google/Facebook/ect)
  • Join the Championify team with the language you'd like to work on
  • Start!

Please prevent from putting translations in PRs, I'd rather keep those for code. I check Transifex every other day, but if you'd like me to get a look at your translations quickly then hit me up on Gitter.