Giter Club home page Giter Club logo

universal-revanced-patches's Introduction

๐Ÿ‘‹๐Ÿงฉ ReVanced Patches template

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.

For an example repository, see ReVanced Patches.

๐Ÿš€ Get started

To start using this template, follow these steps:

  1. Create a new repository using this template
  2. Set up the build.gradle.kts file (Match the group of the project, manifest attributes, and the POM that will be published to yours)
  3. Update the dependencies in the libs.versions.toml file
  4. Add a secret to your repository named REPOSITORY_PUSH_ACCESS containing a GitHub access token with push access
  5. Set up the README.md file1 (e.g, title, description, license, summary of the patches that are included in the repository)

๐ŸŽ‰ You are now ready to start creating patches!

๐Ÿ”˜ Optional steps

You can also add the following things to the repository:

  • Issue templates2
  • Contribution guidelines3
  • Documentation, if you want to publish your patches as a library4

๐Ÿง‘โ€๐Ÿ’ป 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 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 task needs to be run. The publish task depends on the generateBundle task, so it will be run automatically when publishing a release.

Footnotes

  1. Example README.md file โ†ฉ

  2. Example issue templates โ†ฉ

  3. Example contribution guidelines โ†ฉ

  4. Example documentation โ†ฉ

universal-revanced-patches's People

Contributors

karanveerb avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.