CONTRIBUTING.md 6.66 KB
Newer Older
1
2
# Contributing

3
4
5
6
7
8
Contributions are welcome! Every of your contributions to the content (mainly apps.csv and games.csv) has to be licensed under CC-BY-SA-4.0. 

It is recommended to edit the lists in LibreOffice Calc.

[TBD: Explain CSV import (, as seperator) and efficient editing (highlight B2 and click View > Freeze Rows and Columns"]

9
10
## Easy tasks, great for first-time contributions:

11
12
13
14
15
16
### Check if apps are available on Arch, Mobian, postmarketOS or Flathub. You can easily do so by using [Repology](https://repology.org/).
    * If you are running another distribution, feel free to add an extra column for it and start filling it!
   * Please note: While this is important, a future iteration of this list will likely just include a repology badge, so don't invest all of your time into this!

### Add a new app, e.g.:
#### Up and coming smartphone apps (add after testing):
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
45
46
47
48
49
    * PinePhone modem firmware updater UI: https://git.sr.ht/~martijnbraam/pinephone-modemfw (does not work yet, unlikely to be finished due to firmware licensing issues, go to https://github.com/Biktorgj/quectel_eg25_recovery for now)
    * https://invent.kde.org/carlschwan/quickmail (might now be "Kolibri", see https://www.plasma-mobile.org/2021/04/27/plasma-mobile-update-march-april/)
    * https://invent.kde.org/vandenoever/mailmodel
    * https://gitlab.gnome.org/bilelmoussaoui/camera-rs
    * https://gitlab.gnome.org/bilelmoussaoui/paintable-rs
    * https://github.com/OpenMandrivaSoftware/om-phone
    * https://github.com/OpenMandrivaSoftware/om-camera
    * https://gitlab.com/bhdouglass/rockwork (can this be brought over?)
    * https://git.sr.ht/~alva/rocket
    * https://github.com/naxuroqa/venom 
    * https://github.com/MrBn100ful/Hermes-Messenger (Electron)
    * https://github.com/dskleingeld/pods (GTK podcast app written in Rust)
    * https://github.com/jnetterf/pyrocast (GTK podcast app written in Rust)
    * https://github.com/nbdy/pui
    * https://github.com/nahuelwexd/Replay
    * https://gitlab.gnome.org/GNOME/gnome-network-displays (Flathub: https://flathub.org/apps/details/org.gnome.NetworkDisplays; AUR: gnome-network-displays(-git)
    *  (Flathub: ; AUR: clapper, clapper-git)
    * https://invent.kde.org/rowdyninja/fokus
    * https://nxos.org/maui/maui-apps-1-2-1-released-and-more/ (check whether everything is already on the list)
    * https://blogs.gnome.org/chergert/2021/03/06/a-gtk-4-based-text-editor/
    * https://git.sr.ht/~link2xt/kdeltachat
    * https://github.com/JNissi/camcam WIP Camera app written in Rust
    * https://github.com/JNissi/fastcal WIP Calendar app written in Rust
    * https://codeberg.org/lowkeylone/Interpret 
    * https://github.com/Schmiddiii/tvtoday
    * https://github.com/DavidVentura/hn
    * https://source.puri.sm/todd/Stream
    * https://invent.kde.org/maui/sol (web browser)
    * https://invent.kde.org/maui/booth (camera)
    * https://github.com/arteeh/wasp-companion
    * https://cubocore.org/ apps, see also https://wiki.postmarketos.org/wiki/CoreApps
    * https://github.com/scandinave/kodimote (No commits in 16 months, but..)
    * https://github.com/hongquan/LaTre/tree/master/src/latre (Inactive for a very long time, but works for importing VCF data and comes pre-installed on OpenSUSE)
50
51
52
    * amazfish (https://github.com/piggz/harbour-amazfish)
    * https://flathub.org/apps/details/io.github.lainsce.Emulsion
    * https://invent.kde.org/network/tok
53
54
    
    
55
#### old Linux Phone apps:
56
57
    * Navit
    * FoxtrotGPS
58
    * Maep
59
    
60
#### unoptimized desktop apps that have been run on the Librem 5 or PinePhone successfully and are at least somewhat usable:
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
    * Gnome Photos
    * Gthumb
    * Shotwell // apps from here on where spotted on a screenshot
    * Claws Mail
    * D-Feet
    * Gpredict
    * KiCad
    * Shadowsocks-Qt5
    * [Lyrebird](https://github.com/constcharptr/lyrebird)
    * https://github.com/linuxmint/webapp-manager
    * Verbiste https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/7
    * Simple scan https://gitlab.gnome.org/GNOME/simple-scan (newer versions are only fine after "scale-to-fit simple-scan on")
    * Marble (https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/27)
    * Orage (https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/28)
    * Solar System (https://flathub.org/apps/details/org.sugarlabs.SolarSystem; https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/37)
    * AusweisApp 2 (https://flathub.org/apps/details/de.bund.ausweisapp.ausweisapp2; https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/51)
    * Nixwriter https://flathub.org/apps/details/com.gitlab.adnan338.Nixwriter; https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/69
    * SongRec https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/91
    * Bleachbit https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/101
    * https://github.com/argosopentech/argos-translate
    

83
### Games to add to the game list (make sure to put it in in alphabetical order)
84
85
86
87
88
89
    * AisleRiot (see https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/7)
    * Taquin (https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/7)
    * Reversi (https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/13) 
    * Gnubik (https://forums.puri.sm/t/list-of-apps-that-fit-and-function-well-post-them-here/11361/26)
    * Foobillardplus (https://github.com/alrusdi/foobillardplus | http://foobillardplus.sourceforge.net/ | https://sourceforge.net/projects/foobillardplus/ ~ https://pkgs.org/search/?q=foobillardplus; https://pkgs.org/search/?q=foobillardplus)
   
90
## Further content maintenance tasks:
91
92
* ~~Check and remove further apps that are no longer available (e.g. source code gone) by copying them to archive.csv.~~
* ~~Add games or Apps from "other games.csv" or "other apps.csv".~~
93
* fix typos :D
94
95
96
97
98
99
100
101
102
103
104
* check links again
* transition "Category" over to Freedesktop [categories](https://specifications.freedesktop.org/menu-spec/latest/apa.html) and [Additional categories](https://specifications.freedesktop.org/menu-spec/latest/apas02.html). _feels painful, therefore not yet started._
* ~~transition "License" over to [SPDX identifiers](https://spdx.org/licenses/)~~
* add URLs for appstream-files (per project) _in progress_

## Design tasks: 
* Make AppStream Links work.
* Improve mobile design generally.
* Implement a way to display screenshots and or app logos.
* Implement a form with the necessary fields for apps.csv generation for easier email submission.