epubgrep/CONTRIBUTING.adoc

3.0 KiB
Raw Permalink Blame History

How to contribute

Read the Code of Conduct.

Reporting bugs or suggesting enhancements

Before reporting a bug, please perform a search to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one. Same for enhancements. It is helpful to re-run the command producing a bug with --debug and attaching the log file to the bug report. The log file of the last run is usually in ~/.local/state/epubgrep/epubgrep.log.

You can also contact me via E-Mail, XMPP or the Fediverse if you dont want to open an account.

Pull requests

Please use similar coding conventions as the rest of the project. The basic rule to remember is to write code in the same style as the existing/surrounding code.

Add a copyright line with the year, your name and your email address to the files you edited. Add your name and email to AUTHORS. Unless you dont want to.

You can also send me your patches via E-Mail, ideally using git send-email.

Translations

Creating a new translation

To create a new translation, copy translations/epubgrep.pot to translations/[LANGUAGE ABBREVIATION].po (Replace [LANGUAGE ABBREVIATION] with the correct abbreviation for your language, e.g. “es” if you are translating into Spanish or “pt_BR” if you are translating into Brazilian Portuguese). The pot-file is generated during the build process.

Open your new po file with your favourite text editor, (or you may prefer to use a translation catalog editor like Poedit), and first edit the header section of your file. You will need to replace the text in UPPERCASE with the correct values. The easiest way to work out how to do this is to compare it to another po file that already exists.

Updating your translation

When it is time to update your translation, first update your Git working directory. Then do the following:

cmake --build build
cd translations
msgmerge --update es.po epubgrep.pot

Then open your file and locate the strings that need updating. These will have an empty msgstr or will be marked “fuzzy”.

The translation guide is based on https://www.claws-mail.org/faq/index.php/Translator's_Information, licensed under GFDL-1.2-only.