Skip to content

Import contributor documentation from GitHub wiki #398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

loucasal
Copy link
Contributor

Contributes to #311, as discussed in that issue. The text was proofread/improved in a few places.

@keunes
Copy link
Member

keunes commented Apr 14, 2025

I think we maybe want to split some content off to sub-pages.

  • Code structure & code style
  • Getting test builds
  • Getting credited for your contribution

These make together for quite a long page, and aren't relevant yet if you're orienting yourself, to see if you want to contribute. They also push the 'get in touch' down quite a bit.

https://deploy-preview-398--antennapod-test.netlify.app/contribute/develop/app

@loucasal
Copy link
Contributor Author

Done!

NB: I went back to separate paragraphs for the Getting credited page, as the merged paragraph felt like a rambling wall of text. One paragraph per concept reads a lot more natural to me.

@ByteHamster ByteHamster requested a review from Copilot April 20, 2025 10:51
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request imports and improves contributor documentation from the GitHub wiki to the AntennaPod website.

  • Adds new documentation pages for test builds, getting credited, and code style guidelines.
  • Updates existing content in the app contribution guide and corresponding internationalization keys.
  • Introduces front matter files to support the new documentation pages.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
_i18n/en/contribute/develop/app/test-builds.md New documentation page about obtaining test builds from CI
_i18n/en/contribute/develop/app/getting-credited.md New documentation detailing how contributors can get credited
_i18n/en/contribute/develop/app/code-style.md New documentation on code style guidelines, including resource naming
_i18n/en/contribute/develop/app.md Minor text improvements in the contributor guidance
_i18n/en.yml Updates to include new i18n keys for code style, test builds, and getting credited
_contribute/develop/app/test-builds.md Added front matter for the test builds documentation page
_contribute/develop/app/getting-credited.md Added front matter for the getting credited documentation page
_contribute/develop/app/code-style.md Added front matter for the code style documentation page

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@loucasal
Copy link
Contributor Author

@keunes, do you have other comments or can this be merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants