Update instructions; closes #3
[f-droid:fdroiddata.git] / CONTRIBUTING.md
1 # Contributing to F-Droid
2
3 Thanks so much for contributing to [F-Droid](https://f-droid.org)! Please take your time to read carefully through this document:
4
5 ## Issue Tracker
6 Please note that the tracker is not for app submissions, use the [submission queue](https://f-droid.org/forums/forum/submission-queue/) instead.
7
8 For error reports please provide detailed system (e.g. Android version, used ROM, hardware specifications) and error information (e.g. What happened? When did it happen?) and provide the [logcat](https://developer.android.com/tools/help/logcat.html) -- either by file upload or by inclduing it with the appropriated [markdown](https://github.com/gitlabhq/gitlabhq/blob/master/doc/markdown/markdown.md).
9
10 For update/change requests, please make sure they meet our [inclusion policy](https://f-droid.org/wiki/page/Inclusion_Policy) and are not already handled by our [submission queue](https://f-droid.org/forums/forum/submission-queue/) (or are [held](https://f-droid.org/forums/forum/submission-held/) for some reason). Keep discussions to a minimum or use the forum instead.
11
12 However, the easiest way to get an app included, updated or an error fixed is to provide the required metadata yourself by opening a merge request.
13
14 ## Merge Requests
15 Please read through the [inclusion howto](https://f-droid.org/wiki/page/Inclusion_How-To), the [inclusion policy](https://f-droid.org/wiki/page/Inclusion_Policy) and our [fdroid manual](https://f-droid.org/manual/fdroid.html).
16
17 This section includes some information on the fdroidserver repository as the tools contained in there can be used standalone to check and build local metadata files.
18
19 ### Setting up fdroidserver and build tools
20 * Follow the instructions in [the manual](https://f-droid.org/manual)
21
22 ### Setting up fdroiddata and submitting apps
23 * [Register on GitLab](http://gitlab.com)
24 * Visit and fork the [fdroiddata repository](https://gitlab.com/fdroid/fdroiddata/).
25 * Clone your fdroiddata fork.
26 * Copy fdroiddata/metadata/template or fdroiddata/metadata/template-minimal to fdroiddata/metadata/app.id.txt .
27 * Update metadata/app.id.txt according to the [manual](https://f-droid.org/manual/html_node/Metadata.html).
28 * If you have fdroidserver installed:
29  * Copy and adjust fdroidserver/examples/config.py to fdroiddata/config.py .
30  * Instead of copying a template you can run `fdroid import -u github-url` if the app is hosted on GitHub. 
31  * Run `fdroid checkupdates app.id`, `fdroid rewritemeta app.id` and `fdroid build -v -t -l app.id` before opening a merge request!
32 * Use `git add`, `git commit` and `git push` to update your fork on GitLab. Please squash multiple commits into a single one per app. It's a good style to use a separate branch for each app and prefix commit messages with "Appname:". For this you might also want to look at the `fd-commit` command in the server repo.
33 * Open a merge request via GitLab.