CONTRIBUTING.md 2.59 KB
Newer Older
1
2
# Contributing

3
4
5
6
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.

Peter's avatar
Peter committed
7
[TBD: Explain CSV import (, as seperator) and efficient editing (highlight B2 and click View > Freeze Rows and Columns")]
8

9
10
For apps.csv, please add apps below existing apps.

11
12
## Easy tasks, great for first-time contributions:

13
### Check if apps are available on Arch, Mobian, postmarketOS or Flathub. You can easily do so by using [Repology](https://repology.org/).
Peter's avatar
Peter committed
14
15
* 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!
16

17
### Add a new app
Peter's avatar
Peter committed
18
* Candidates are listed in [apps-to-be-added.md](apps-to-be-added.md).
19

20
### Games to add to the game list (make sure to put it in in alphabetical order)
Peter's avatar
Peter committed
21
22
23
24
25
* 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)
26
* and more on [other games.csv](other games.csv).
27
   
28
## Further content maintenance tasks:
29
30
* ~~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".~~
31
* fix typos :D
32
* check links again
Peter's avatar
Peter committed
33
* add Freedesktop [categories](https://specifications.freedesktop.org/menu-spec/latest/apa.html) and [Additional categories](https://specifications.freedesktop.org/menu-spec/latest/apas02.html) to a new field, old categories are supposed to stay. _In progress_
34
* ~~transition "License" over to [SPDX identifiers](https://spdx.org/licenses/)~~
Peter's avatar
Peter committed
35
* add URLs for appstream-files (per project) _almost done, needs to be re-checked_
36
37

## Design tasks: 
Peter's avatar
Peter committed
38
* ~~Make AppStream Links work.~~
39
40
41
* 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.