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

ADD encourage contributions to the template #69

Merged
merged 2 commits into from
Sep 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ A template for creating Android projects at Q42.
1. Click the green "Use this template" button in the Github repo to create your own repository with
this code template.
1. Clone the new repo locally on your machine.
1. Update dependencies and check whether everything still works. After that, create a PR to the
`main` branch of this template. This helps both your project and this template to stay up to date.
1. Run `python ./scripts/rename-project.py` or `python3 ./scripts/rename-project.py` from the
project root, to change the project name and the package names. The script will ask for your new
project name and update all references.
Expand All @@ -20,6 +22,8 @@ A template for creating Android projects at Q42.
1. You probably want to enable the self-hosted runner (our own, free and fast, mac-mini), as described
in [self hosted runner](#self-hosted-runner), when using Github Actions.
1. Setup/adjust uploads to [Firebase app distribution](#firebase-app-distribution).
1. Build your awesome project :-)
1. Consider contributing to this template when you find something that could be improved.

## Contributing

Expand Down