Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.29 KB

DEVELOPER-INFO.md

File metadata and controls

52 lines (31 loc) · 2.29 KB
Raw

🔨 lorax: Developer Info

☑️ Github changes

Some general project settings are indicated as follows:

General

Under Pull Requests

  • Allow merge commits 🔳 DISABLE
  • Allow squash merging 🔳 DISABLE
  • Allow rebase merging ✅ ENABLE

Branch Protection Rules

Under Protect matching branches

  • Require a pull request before merging ✅ ENABLE
  • Require linear history ✅ ENABLE
  • Do not allow bypassing the above settings ✅ ENABLE

☑️ Code coverage

  • coveralls.io: add maestro project

🌐 l10n Translations

This module has been setup to support localisation. The default language is en-GB with support for en-US. There is a translation file for en-US defined as i18n/deploy/lorax.active.en-US.json. This is the initial translation for en-US that should be deployed with the app.

Make sure that the go-i18n package has been installed so that it can be invoked as cli, see go-i18n for installation instructions.

To maintain localisation of the application, the user must take care to implement all steps to ensure translate-ability of all user facing messages. Whenever there is a need to add/change user facing messages including error messages, to maintain this state, the user must:

  • define template struct (xxxTemplData) in src/i18n/messages.go and corresponding Message() method. All messages are defined here in the same location, simplifying the message extraction process as all extractable strings occur at the same place. Please see go-i18n for all translation/pluralisation options and other regional sensitive content.

For more detailed workflow instructions relating to i18n, please see i18n README