Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 2.31 KB
Raw

Report a bug

You can use New issue -> Bug report to file a new bug report.
Please do so even if you are not sure whether or not the product should behave the way you expect it to, as this may hide, at the very least, some shortages in the way the plug-in communicates what it does.

Request a feature you would like implemented

You can use New Issue -> Feature request to propose a new feature for this plug-in.
If it is an already existing feature, go ahead anyway and propose a way to enhance it.

Help with translating the plug-in

There two main types of assets that need translation:

  • the user interface strings (labels, system messages etc.), which are provided and stored in classic .mo files, with a source .pot template file that can be used as base for translation (in this case, the lib/abp01-trip-summary.pot file);
  • the help content, which is provided as HTML files, one per each language, each with a source markdown (.md) file.

Translating user interface strings

The way you translate user interface strings is by installing POEdit, loading the provide .pot file and, on that basis, provide the translation for the language you want. See this guide for an example.
The result is a .mo file and a .po file, which you then commit and create a pull request.

When done, open a new issue and request that it be processed and added as a plug-in translation.

Translating help files

The help content is written, for each language, in a markdown (.md) file called index.md, located, for each language, in the help/src/{language_code} folder (ex. help/src/ro_RO/index.md). This content is then be built as HTML files when the plug-in installation kit is created, but it can also be built on demand.

Actively contribute to the code base

You can contribute to the code base itself either by: