File: CONTRIBUTING.md

package info (click to toggle)
ticketbooth 1.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,776 kB
  • sloc: python: 4,967; makefile: 5; sh: 1
file content (44 lines) | stat: -rw-r--r-- 1,653 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Contributing

Ticket Booth is a Linux app built with Python using the GTK4 toolkit and libadwaita. The only officially supported packaging format is Flatpak.

## Code

When contributing to the source code, use the same style and conventions present in the files already in the repo. \
All contributions are and will always be welcome.\
If you have an idea, feel free to create an issue, and let's discuss it. You can also fork the repo, make your changes, and submit a pull request to change the code yourself.

## Translations

This project is translated via [Weblate](https://hosted.weblate.org/engage/ticket-booth/) (preferred). Alternatively, you can translate manually by doing the following:

1. Clone the repository.
2. If it isn't already there, add your language to `/po/LINGUAS`.
3. Create a new translation from the `/po/ticketbooth.pot` file with a translation editor such as Poedit.
4. Save the file as `[YOUR LANGUAGE CODE].po` to `/po/`.
5. Create a pull request with your translations.

## Building

### Gnome Builder

The quickest and easiest way

1. Install GNOME Builder.
2. Click "Clone Repository" with https://github.com/aleiepure/ticketbooth.git as the URL.
3. Click on the build button (hammer) at the top.

### Flatpak builder and other IDEs

```shell
git clone https://github.com/aleiepure/ticketbooth
flatpak-builder --repo=/path/to/repo/dir --force-clean --user /path/to/build/dir me.iepure.Ticketbooth.Devel.json
flatpak remote-add --user ticketbooth ticketbooth --no-gpg-verify
flatpak install --user ticketbooth me.iepure.Ticketbooth.Devel
```

Then run with

```shell
flatpak run --user me.iepure.Ticketbooth.Devel
```