Contributor documentation

[keunes]

Short description: Add contributor documentation.

Location:

Why have this:

From AntennaPod/AntennaPod#6834 (comment):

It would be nice if there was an easy way to auto-format it according to the requirements but I didn't see anything in the contributor guide

The contributor's page for 'Develop' links to this wiki page: https://github.com/AntennaPod/AntennaPod/wiki/Code-style. Apparently it's not visible enough.

Also, the Contribute > Translations page is rather long and complicated.

More info:

Pages to include:

• Requesting new languages
• Using Weblate
• Code style
• Building AntennaPod
• About debug versions

Also to mention somewhere:

• Discussions on functionality in the Forum
• Concrete/boiled down solution descriptions in Issues
• Technical/Implementation discussions in PRs

[ByteHamster]

I'm still not really convinced that the public website should hold very technical stuff like the developer documentation. The comment linked above doesn't imply that they did not find the developer documentation. It just says that the developer documentation does not contain what they were looking for (now it does).

[keunes]

The comment linked above doesn't imply that they did not find the developer documentation. It just says that the developer documentation does not contain what they were looking for (now it does).

I didn't realise you edited the wiki page to add the info :-)

I'm still not really convinced that the public website should hold very technical stuff like the developer documentation

It doesn't have to be in the menu, confusing 'regular' users. But as a) important information for contributors is currently spread over different places and b) hard to process (at least the translations), we need to do something to address both issues.

And as our main website goal is to attract contributors and ensures a good mix of controllability and openness (using PRs, impossible combination on the wiki), I find it the most appropriate place. (But if you have another proposal that addresses identified issues, I'm all ears.)

[antennapod-bot]

This issue has been mentioned on AntennaPod Forum. There might be relevant details there:

https://forum.antennapod.org/t/project-management/3879/3