forked from ReVanced/revanced-patches-template
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from Slenderman00/main
Main => Dev
- Loading branch information
Showing
5 changed files
with
20 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,25 @@ | ||
# 👋🧩 ReVanced Patches template | ||
[![Release](https://github.com/Slenderman00/revanced-patches-grindr/actions/workflows/release.yml/badge.svg)](https://github.com/Slenderman00/revanced-patches-grindr/actions/workflows/release.yml) | ||
|
||
This is a template for creating a new ReVanced Patches repository. | ||
The repository can have multiple patches, and patches from other repositories can be used together. | ||
# 🤙 ReVanced Patches for Grindr | ||
This patch unlocks "Unlimited" functionality in the Grindr application. | ||
|
||
For an example repository, see [ReVanced Patches](https://github.com/revanced/revanced-patches). | ||
# Usage | ||
To use this project: | ||
Make ```Slenderman00``` the patches organization for your revanced app and make ```revanced-patches-grindr``` the Source | ||
|
||
## 🚀 Get started | ||
![image](https://i.imgur.com/f9Y9S4l.png) | ||
--- | ||
|
||
To start using this template, follow these steps: | ||
## Acknowledgements | ||
|
||
1. [Create a new repository using this template](https://github.com/new?template_name=revanced-patches-template&template_owner=ReVanced) | ||
2. Set up the [build.gradle.kts](build.gradle.kts) file (Match the [group of the project](build.gradle.kts#L8), [manifest attributes](build.gradle.kts#L35-L43), and the [POM](build.gradle.kts#L84-L106) that will be published to yours) | ||
3. Update the dependencies in the [libs.versions.toml](gradle/libs.versions.toml) file | ||
4. [Add a secret](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) to your repository named [REPOSITORY_PUSH_ACCESS](.github/workflows/release.yml#L47) containing a GitHub access token with [push access](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#authentication) | ||
5. Set up the [README.md](README.md) file[^1] (e.g, title, description, license, summary of the patches that are included in the repository) | ||
- [Grindr Plus](https://github.com/ElJaviLuki/GrindrPlus) | ||
|
||
🎉 You are now ready to start creating patches! | ||
## Contact | ||
- You can find me on [this discord server](https://discord.gg/SPb6Kc7S4C) | ||
- Other contact information can be found on my website [joar.me](https://joar.me) | ||
## Contributing | ||
|
||
## 🔘 Optional steps | ||
Contributions are always welcome! | ||
|
||
You can also add the following things to the repository: | ||
We are currently looking for someone to write the `contributing.md` and the `code of conduct`. | ||
|
||
- [Issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)[^2] | ||
- Contribution guidelines[^3] | ||
- Documentation, if you want to publish your patches as a library[^4] | ||
|
||
[^1]: [Example README.md file](https://github.com/ReVanced/revanced-patches/blob/main/README.md) | ||
[^2]: [Example issue templates](https://github.com/ReVanced/revanced-patches/tree/main/.github/ISSUE_TEMPLATE) | ||
[^3]: [Example contribution guidelines](https://github.com/ReVanced/revanced-patches/blob/main/CONTRIBUTING.md) | ||
[^4]: [Example documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs) | ||
|
||
## 🧑💻 Usage | ||
|
||
In order to develop and release ReVanced Patches using this template, some things need to be considered: | ||
|
||
- Development originates in feature branches. Once a feature branch is ready, it is squshed and merged into the `dev` branch | ||
- The `dev` branch is merged into the `main` branch once it is ready for release | ||
- Semantic versioning is used for versioning ReVanced Patches. ReVanced Patches have a public API for other patches to use | ||
- Semantic commit messages are used for commits | ||
- Commits on the `dev` branch and `main` branch are automatically released via the [release.yml](.github/workflows/release.yml) workflow, which is also responsible for generating the changelog and updating the version of ReVanced Patches. It is triggered by pushing to the `dev` or `main` branch. The workflow uses the `publish` task to publish the release of ReVanced Patches | ||
- In order to build ReVanced Patches, that can be used on Android, the [`generateBundle`](build.gradle.kts#L48-L70) task needs to be run. The [`publish` task depends on the `generateBundle`](build.gradle.kts#L74-L76) task, so it will be run automatically when publishing a release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
org.gradle.parallel = true | ||
org.gradle.caching = true | ||
kotlin.code.style = official | ||
version = 1.0.0 | ||
version = 1.0.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters