From 099b279c63d7a3770729923c7e29f0ee0296327e Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Thu, 14 Sep 2023 01:09:53 +0200 Subject: [PATCH] docs: Add contribution guidelines --- CONTRIBUTING.md | 106 ++++++++++++++++++ README.md | 2 +- .../revanced-headline-vertical-dark.svg | 1 + .../revanced-headline-vertical-light.svg | 1 + assets/revanced-logo/revanced-logo-round.svg | 1 + 5 files changed, 110 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md create mode 100644 assets/revanced-headline/revanced-headline-vertical-dark.svg create mode 100644 assets/revanced-headline/revanced-headline-vertical-light.svg create mode 100644 assets/revanced-logo/revanced-logo-round.svg diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..131ffa770 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,106 @@ +

+ + + + +
+ + +     + + + + + +     + + +     + + +     + + +     + + +     + + +     +
+
+ Continuing the legacy of Vanced +

+ +# 📙 ReVanced Patches contribution guidelines + +This document describes how to contribute to ReVanced Patches. + +## 📖 Resources to help you get started + +* [The documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs) provides the fundamentals of patches +and everything necessary to create your own patch from scratch +* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on +* [Issues](https://github.com/ReVanced/revanced-patches/issues) are where we keep track of bugs and feature requests + +## 🙏 Submitting a patch request + +Patches can be requested by opening an issue using the +[Patch request issue template](https://github.com/ReVanced/revanced-patches/issues/new?assignees=&labels=patch-request&projects=&template=patch-request.yml&title=feat%3A+). + +> **Note** +> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Patches. +> Good motivation has to be provided for a request to be accepted. + +## 🐞 Submitting a bug report + +If you encounter a bug while using ReVanced Patches, open an issue using the +[Bug report issue template](https://github.com/ReVanced/revanced-patches/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+). + +## 🧑‍⚖️ Guidelines for requesting or contributing patches + +To maintain a high-quality and ethical collection of patches, the following guidelines for requesting +or contributing patches are effective as of September 14, 2023. Any patches present prior to this date +are unaffected by this change. + +> **Note** +> We generally adhere to the guidelines outlined below. However, we may make exceptions +> in specific cases based on our discretion. Pull requests for patches that deviate from the guidelines +> will be evaluated individually. While a patch may not align with our general guidelines, +> we will consider its acceptance on a case-by-case basis, taking into account its impact on user experience +> and ethical considerations. We reserve the right to make exceptions for patches that provide significant value. + +✅ Examples for acceptable patches include: + +* Customizations: Feel free to contribute patches that allow users to personalize their experience +* Ad-Blocking: Patches aimed at enhancing user privacy and blocking intrusive advertisements are appreciated +* Feature additions: Patches that add new features or change behaviour to the app are welcome + +❌ Examples for unacceptable patches include: + +* Payment circumvention: We do not accept patches that exist solely to bypass payment for the app or any of its features +* Malicious patches: Patches that are malicious in nature are not allowed + + +## 📝 How to contribute + +1. Before contributing, it is recommended to open an issue to discuss your change +with the maintainers of ReVanced Patches. This will help you determine whether your change is acceptable +and whether it is worth your time to implement it +2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev` +3. Commit your changes. In case you are contributing a new patch, make sure to follow the conventions for patches +described in the [documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs) +4. Submit a pull request to the `dev` branch of the repository and reference issues +that your pull request closes in the description of your pull request +5. Our team will review your pull request and provide feedback. Once your pull request is approved, +it will be merged into the `dev` branch and will be included in the next release of ReVanced Patches + +❤️ Thank you for considering contributing to ReVanced Patches, +ReVanced diff --git a/README.md b/README.md index 79fde2b82..b76165a9b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ -## 🧩 ReVanced Patches +# 🧩 ReVanced Patches Patches for ReVanced. diff --git a/assets/revanced-headline/revanced-headline-vertical-dark.svg b/assets/revanced-headline/revanced-headline-vertical-dark.svg new file mode 100644 index 000000000..a59bfb50b --- /dev/null +++ b/assets/revanced-headline/revanced-headline-vertical-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/revanced-headline/revanced-headline-vertical-light.svg b/assets/revanced-headline/revanced-headline-vertical-light.svg new file mode 100644 index 000000000..3c5eeccc7 --- /dev/null +++ b/assets/revanced-headline/revanced-headline-vertical-light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/revanced-logo/revanced-logo-round.svg b/assets/revanced-logo/revanced-logo-round.svg new file mode 100644 index 000000000..901e1914b --- /dev/null +++ b/assets/revanced-logo/revanced-logo-round.svg @@ -0,0 +1 @@ + \ No newline at end of file