:project: epubgrep
:uri-base: https://schlomp.space/tastytea/{project}
:uri-branch-main: {uri-base}/src/branch/main
:uri-coc: {uri-branch-main}/CODE_OF_CONDUCT.adoc
:contact-email: tastytea@tastytea.de
:contact-xmpp: {contact-email}
:contact-fediverse: https://likeable.space/users/tastytea
:uri-git-format-patch: https://git-scm.com/docs/git-format-patch
:uri-git-send-email: https://git-scm.com/docs/git-send-email
:uri-poedit: https://poedit.net/

== How to contribute

Read the link:{uri-coc}[Code of Conduct].

=== Reporting bugs or suggesting enhancements

Before reporting a bug, please
https://schlomp.space/tastytea/{project}/issues[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 mailto:{contact-email}[E-Mail],
link:xmpp:{contact-xmpp}[XMPP] or the {contact-fediverse}[Fediverse] if you
don't 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
link:{uri-branch-main}/AUTHORS[AUTHORS]. Unless you don't want to.

You can also send me your patches via mailto:{contact-email}[E-Mail], ideally
using link:{uri-git-send-email}[git send-email].

=== Translations

==== Creating a new translation

To create a new translation, copy `translations/{project}.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 link:{uri-poedit}[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:

[source,shell]
--------------------------------------------------------------------------------
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._
