Skip to content
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

docs: add Google Play badge to README.md and remove contributors #86

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mipro98
Copy link
Collaborator

@mipro98 mipro98 commented Apr 13, 2024

I improved our README a bit: I added a Google Play badge and removed the Contributors section for now since it is visible anyways on the sidebar of the repository in an equal fashion.

Link to a rendered version of new README

@mipro98 mipro98 added the documentation Improvements or additions to documentation label Apr 13, 2024
@mipro98 mipro98 requested a review from matthiasemde April 13, 2024 08:31
Copy link
Owner

@matthiasemde matthiasemde left a comment

Choose a reason for hiding this comment

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

I would decline this PR. But we can of course talk about it if you want.

README.md Outdated
@@ -11,25 +11,32 @@ Your personal practice companion
</p>

<br/>

<p align="center">
<a href='https://play.google.com/store/apps/details?id=app.musikus&hl=de&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'>
Copy link
Owner

Choose a reason for hiding this comment

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

I don't think, we should use the GooglePlay Badge while the link only works for our alpha testers.

Copy link
Collaborator Author

@mipro98 mipro98 Apr 13, 2024

Choose a reason for hiding this comment

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

Do you think it confuses people who don't read the description and wonder why the link is not working 😅?

Adding a Google Play badge is kind of an eyecatcher to see that we are already testing the app on Google Play.

README.md Outdated
If you want to join our group of testers, write us an email to [[email protected]](mailto:[email protected]) using your Gmail-account and we will add you to the list.

If you want to join our group of testers, write us an email to [[email protected]](mailto:[email protected]) using your Google account and we will add you to the list. If you are amongst the list of testers, the badge above will bring you to the Play Store listing.
Alternatively, you can always download the latest release [from GitHub](https://github.com/matthiasemde/musikus-android/releases/latest).
Copy link
Owner

Choose a reason for hiding this comment

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

People can download the latest release from GitHub, but then they are not really joining the alpha. The alpha is happening on GooglePlay.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Okay, fair point. But I would like to encourage people to test the app even though they might not want to be an "official alpha tester".
It's just about mentioning that our releases are also uploaded to GitHub.

Maybe we can rephrase it to something like "Pre-built release apks can be found on the release page".

README.md Outdated
## 👨‍💻 Contributors
<a href="https://github.com/matthiasemde/musikus-android/graphs/contributors">
<img width="140" src="https://contrib.rocks/image?repo=matthiasemde/musikus-android" alt="https://github.com/matthiasemde/musikus-android/graphs/contributors"/>
</a>
Copy link
Owner

Choose a reason for hiding this comment

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

I know it's a gimmick, but I really like the contributors page.

@mipro98
Copy link
Collaborator Author

mipro98 commented Apr 19, 2024

Since the CI badge showed "failing" because of a recent CI run in an intermediate branch in a PR, I added ?branch=main as described here but it indicated "no status". @matthiasemde do you have an idea why?

@matthiasemde
Copy link
Owner

matthiasemde commented Apr 20, 2024

Since the CI badge showed "failing" because of a recent CI run in an intermediate branch in a PR, I added ?branch=main as described here but it indicated "no status". @matthiasemde do you have an idea why?

My guess is, that the CI has never actually run for branch=main. It only ever runs for branches for which a PR is opened.
That being said, I'm not really sure what the desired behavior is in our case.

matthiasemde
matthiasemde previously approved these changes Jul 14, 2024
@matthiasemde matthiasemde self-requested a review July 14, 2024 17:29
@matthiasemde matthiasemde dismissed their stale review July 14, 2024 17:29

I was under the water

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

Successfully merging this pull request may close these issues.

2 participants