👋🧩 Morphe Patches template

Template repository for Morphe Patches.

 

❓ About

This is a template to create a new Morphe Patches repository.
The repository can have multiple patches, and patches from other repositories can be used together.

For an example repository, see Morphe Patches.

Morphe Patches template is based off the prior work of ReVanced. All modifications made by Morphe, along with their dates, can be found in the Git history.

🚀 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 (Specifically, the group of the project, and the About)
3. Set up the README.md file¹ (e.g, title, description, license, summary of the patches that are included in the repository), the issue templates² and the contribution guidelines³
4. Choose a name for your patches project. Keep in mind you must use a unique name that does not imply or suggest authorship by the Morphe open source project. See the NOTICE for details.

🎉 You are now ready to start creating patches!

🧑‍💻 Usage

To develop and release Morphe Patches using this template, some things need to be considered:

• Development starts in feature branches. Once a feature branch is ready, it is squashed 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 to version Morphe Patches. Morphe 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 Morphe Patches. It is triggered by pushing to the dev or main branch. The workflow uses the publish task to publish the release of Morphe Patches
• The buildAndroid task is used to build Morphe Patches so that it can be used on Android. The publish task depends on the buildAndroid task, so it will be run automatically when publishing a release.

📚 Everything else

📙 Contributing

Thank you for considering contributing to Morphe Patches template.
You can find the contribution guidelines here.

🛠️ Building

To build Morphe Patches template, you can follow the Morphe documentation.

📜 License

Morphe Patches are licensed under the GNU General Public License v3.0, with additional conditions under GPLv3 Section 7:

• Name Restriction (7c): The name "Morphe" may not be used for derivative works.
  Derivatives must adopt a distinct identity unrelated to "Morphe."

See the LICENSE file for the full GPLv3 terms and the NOTICE file for full conditions of GPLv3 Section 7

Footnotes

1. Example README.md file ↩

2. Example issue templates ↩

3. Example contribution guidelines ↩