Applications by category / Contributing

From postmarketOS
Jump to navigation Jump to search

Thanks for wanting to contribute to postmarketOS' applications list! Please skim through following notices to avoid misunderstandings. If you are unsure whether your app satisfies the requirements, please open an issue on the wiki's GitLab page. Do the same when you want to excite a discussion about any of the requirements!

Note: Following guidelines are not effective for inclusions of apps in the repository, but only for the Applications by category page that is intended to serve as an application discovery page for postmarketOS users.

General Overview

This application list is strongly inspired by ArchWiki's List of Applications. As such, a slightly modified version of ArchWiki's app template is used. The only difference lies in the introduction of app antifeatures via the template Template:AppAntifeature (or its short-hand alias Template:Appaf) which are in turn based upon F-Droid's Anti-Features. Those antifeatures are used to describe properties of an application not adhering to postmarketOS' principles or otherwise not following the intentions of the pmOS project (e.g. apps originally not designed for mobile etc.).

Requirements for inclusion of apps

Since postmarketOS is suited towards mobile use and has some rather strict principles, the requirements of inclusion into this app list differ heavily from Arch's ones. Included apps must be

  • available on Alpine / pmOS via official repositories or a supported 3rd party distribution channel (e.g. Flatpak)
  • usable on mobile, at least through custom tweaks (thus: no CLI applications)
  • non-proprietary (but open clients for proprietary web-services are allowed, even if discouraged)
  • any antifeatures must be tagged!

Antifeatures

Most antifeatures just describe some property that isn't following postmarketOS' principles. You may look at Template:AppAntifeature for a complete list of currently implemented antifeatures and use of that template. For custom antifeatures, you may pass 0 to the first argument. If your custom antifeature may be used more than once, feel free to add it to the template! Or start a discussion about a new antifeature in the wiki's issues.

Some antifeatures describe properties that are not just violating postmarketOS' principles, specifically:

  • 1: This app needs to be installed from a third-party Flatpak repository.
Since postmarketOS doesn't control such 3rd-party repositories, every app distributed on those should be flagged with an antifeature. Right now, there is only one for Flatpak distribution, but please add an antifeature for your (supported) 3rd-party distribution channel of choice if needed (e.g. for AppImages).
  • 5: This app doesn't work out of the box well on mobile. (i.e. manual tweaks by the user are required)
This antifeature is used for apps that work on mobile, but to do so the user needs to apply manual tweaks (i.e. mobile support is neither managed by the upstream application nor pmOS / Alpine). If you add this antifeature to your app, it would be greatly appreciated to add a separate app wiki page describing the required tweaks.

Usage of templates

Here is an overview of commonly used templates in the list:

Detailed usage instructions and an overview of all arguments can be found on their respective wiki pages. Please be careful when editing those, since it may break our application page! For a general introduction to MediaWiki Templates, look at this page in their wiki. Last remark: Please use the templates!

Apps not available on pmOS

… can not be included (as mentioned above) in this list. If you are willing to maintain the package in Alpine Linux or postmarketOS, you can take a shot at packaging it yourself. Don't hesitate to ask for help in our various chat channels.

If you think there is a great benefit in having the package in postmarketOS or Alpine, and you can't package it yourself, consider reporting an issue in the pmaports tracker.

Further notices

Information in the following passage is likely to become outdated quickly.

Right now there is no central roadmap for the application page. If you want to help, but don't know where to start, you may be interested in this GitLab issue (wiki#59) which includes current TODO items. Same goes for application requests (if you don't want / have the time to add them yourself), at the moment the right place to discuss this is aforementioned issue.