Localization Guidelines

Localization Guidelines

• Create Fat Free CRM fork by going to "http://github.com/fatfreecrm/fat_free_crm":http://github.com/fatfreecrm/fat_free_crm and clicking fork button. This will fork the main repository and redirect to your fork page: %{color:green}http://github.com/&lt;your-username&gt;/fat_free_crm%. Notice "Your clone URL" link: %{color:green}git@github.com:<your-username>/fat_free_crm.git%. Use it to make a local clone of your fork:

  $ git clone git@github.com:{your-username}/fat_free_crm.git

• Create or edit config/settings.yml, and set :per_user_locale to true. Then follow Fat Free CRM "installation instructions":http://wiki.github.com/michaeldv/fat_free_crm/installation. Once you have it up and running take a look at locale files in config/locales directory. Each translation consists of two files: {locale}.yml containing Ruby on Rails message translations as maintained by "rails-i18n project":http://github.com/svenfuchs/rails-i18n, and {locale}_fat_free_crm.yml file that stores all Fat Free CRM-specific messages; this is the one that requires translation.

• Start by copying US/English locale file, for example:

  $ cp config/locale/en-US_fat_free_crm.yml config/locale/fi_fat_free_crm.yml

• Change first two lines in your new {locale}_fat_free_crm.yml file to specify your locale and language names, then proceed with translating individual messages.

• To test your translation change Language option on User's Profile page. Fat Free CRM should reload the page with currently selected language. To change default language setting, add or edit the @:locale@ key in config/settings.yml, then restart your server.

• To commit your changes and push them to Github do the following:

$ git status $ git diff $ git add . $ git commit -a -m "Translated to {language}" $ git push

• Send a pull request to merge your translation into the master branch.