How to contribute to Drawing
- If you find a bug
- If you want a new feature
- If you want to translate the app
- If you want to fix a bug or to add a new feature
- How to install from the source code
- If you want to package the app
- If you can, try to check if the bug has already been fixed but not released.
- Report it with informations required by the adequate issue template.
- If it's meaningful, try to include screenshots.
- If you can, try to check if the feature has already been added but not released.
- Report it with informations required by the adequate issue template.
- In the report, explain what it does, not how it does it.
Notice that this procedure will translate the unstable, unreleased version
currently developed on the master
branch.
You don't have to update your translation each time i update the files!
Doing it just before the planned date of a major release should be enough; there are around two major releases per year, and 1 minor release per month.
Their dates are written in
debian/changelog
.
- Fork the repo and clone your fork on your disk (see installation instructions here)
- If the translation exists but is incomplete:
- Find the file corresponding to your language in the the
po
directory.
- Find the file corresponding to your language in the the
- If the translation doesn't exist at all:
- Add your language to
po/LINGUAS
- Run
msginit -i po/drawing.pot --locale=xx -o po/xx.po
, wherexx
should be replaced by the ISO code of your language. This command will produce a.po
file for your language in thepo
directory.
- Add your language to
Use a text editor or an adequate app
to translate the strings of this .po
file.
Concerning the "original version" in english: i'm not a native english speaker, so there might be mistakes. If you find incorrect english labels, please report an issue about them.
There are comments in the file to give context helping you to translate some strings, please take them into account.
Example of something translators can't guess so it's written in the comments:
since this app is a clone of MS Paint, Paint;
(untranslated) has to be in the
list of keywords for finding the app in searchable menus or software centers.
When words have an underscore in them, it defines a keyboard accelerator working
with the Alt key: for example, if an english-speaking user uses a
layout with a menu-bar, pressing Alt+F will open the
_File
menu.
In translations, the underscore can be on another character of the word, but translators should take into account that 2 labels activatable at the same time can't share the same accelerator.
Example: Édi_tion
and Ou_tils
can't work, but É_dition
and Ou_tils
can
work.
Also, the character should be accessible easily from the keyboard layouts of your language.
If you want to test your translation:
- The flatpak SDK isn't able to run a translated version of the app, so
export it as a
.flatpak
file and install it withflatpak install path/to/that/file
. - Or (it's harder) install it with
meson
.
- Run
git add po && git commit && git push
- Submit a "pull request"/"merge request"
- It's better if an issue you fix is reported first
- Tell on the issue that you'll try to fix it
If you find anything weird in the code, or don't understand it, feel free to ask me about it.
To set up a development environment, see here.
You will not get updates with this installation method so please do that only for contributing to development, translations, testing, or packaging.
This app is developed using GNOME Builder and its support for flatpak
:
- Open GNOME Builder
- Click on "Clone a repository…" and use this address:
https://github.com/maoschanz/drawing.git
- Open it as a project with GNOME Builder
- Be sure the runtime is installed (if it doesn't suggest it automatically,
Ctrl+Return → type
update-dependencies
) - Click on the Run button
See here for the list of dependencies.
Get the code:
git clone https://github.com/maoschanz/drawing.git
Build the app:
cd drawing
meson _build
ninja -C _build
Install the app (system-wide):
sudo ninja -C _build install
(if you know the options to install user-wide, please tell)
The app can then be removed with:
cd _build
sudo ninja uninstall
With flatpak-builder (not recommended, that's just for me)
Initial setup of the local flatpak repository:
wget https://raw.githubusercontent.com/maoschanz/drawing/master/com.github.maoschanz.drawing.json
flatpak-builder --force-clean _build2/ --repo=_repo com.github.maoschanz.drawing.json
flatpak --user remote-add --no-gpg-verify local-drawing-repo _repo
flatpak --user install local-drawing-repo com.github.maoschanz.drawing
Update:
flatpak-builder --force-clean _build2/ --repo=_repo com.github.maoschanz.drawing.json
flatpak update
You can also build a debian package with the script deb_package.sh
, but you
won't get updates that way, so don't do that. You probably don't have all the
dependencies to make the script work anyway.
Stable versions for end-users are tagged, and listed in this Github repo's "Releases" section.
0.4.1 0.4.2 … 0.4.14 0.6.3 0.6.4
_.______.____…____. _.______._
0.2 / ______ 0.6.0 0.6.1 0.6.2 /
____.____/_________/______\________.______.______.___/____________
\____________/
Please don't package anything aside this tagged code
(except if your distro have experimental repos)
How to set up the debian experimental repository
sudo apt -t experimental install drawing
(Debian packages names are used here)
- GObject Introspection (GI) for python3 (on Debian, it's
python3-gi
). cairo
library's GI for python3 (on Debian, it'spython3-gi-cairo
).- GTK libraries' GI (on Debian, it's
gir1.2-gtk-3.0
).
Minimal versions of the dependencies:
python3-gi |
python3-gi-cairo |
gir1.2-gtk-3.0 |
|
---|---|---|---|
0.2 | any | any? | 3.22 |
--------------- | ------------ | ------------------ | ---------------- |
0.4.1, 0.4.2 | ≥3.30.0 | any? | 3.22 |
0.4.3 to 0.4.13 | any | any? | 3.22 |
0.4.14 | ≥3.32 | any? | 3.22 |
0.4.15 | any | any? | 3.22 |
--------------- | ------------ | ------------------ | ---------------- |
0.6.0 to 0.6.1 | ≥3.32.0 | any? | 3.22 |
0.6.2 | ≥3.30.0 | any? | 3.22 |
0.6.3 to 0.6.?? | any | any? | 3.22 |
master 's HEAD |
≥3.30.0 | any? | 3.22 |
meson
. The version of meson required by themeson.build
file at the root of the project can be changed if necessary, but please don't add this change to your commit(s).- [optional]
appstream-util
(validation of the.appdata.xml
file) libglib2.0-dev-bin
(IIRC that one is to compress the.ui
files and the icons into a.gresource
file)