missytake/fdroiddata
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Contributing: split building, more recommendations

Browse source
This commit is contained in:
Daniel Martí 2015-08-18 17:18:35 -07:00
parent 46a36fde1e
commit e51e560cda
1 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -43,13 +43,20 @@ You can use the [metadata section](https://f-droid.org/manual/html_node/Metadata
in the manual for reference, or the full template at `templates/app-full` for in the manual for reference, or the full template at `templates/app-full` for
some suggestions. some suggestions.
As for the build recipe, you can have a look at the build templates at
`templates/build-*` for some quick suggestions. Otherwise, follow the manual
and look at how other apps are built.
* Once you're done, see if `fdroid readmeta` runs without any errors. If it * Once you're done, see if `fdroid readmeta` runs without any errors. If it
doesn't, there are syntax errors in your metadata file. doesn't, there are syntax errors in your metadata file.
### Building it
We build apps from source, so a new app must have at least one working build.
You can have a look at the build templates at `templates/build-*` for some
quick suggestions. You may also follow the manual or look at how other apps
are built for working examples.
* Run `fdroid readmeta` again to make sure there still aren't any syntax
errors
* Run `fdroid rewritemeta app.id` to clean up your file * Run `fdroid rewritemeta app.id` to clean up your file
* Run `fdroid checkupdates app.id` to fill automated fields like `Auto Name` * Run `fdroid checkupdates app.id` to fill automated fields like `Auto Name`
@ -68,3 +75,8 @@ to appear in our repository.
### General recommendations ### General recommendations
* [Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) your commits * [Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) your commits
* Make sure you've ran `fdroid lint` and `fdroid rewritemeta` before opening a
merge request
* If you haven't tested your build, say so in the merge request.