126 lines
6.6 KiB
Markdown
126 lines
6.6 KiB
Markdown
<p align="center">
|
|
<picture>
|
|
<source
|
|
width="256px"
|
|
media="(prefers-color-scheme: dark)"
|
|
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
|
>
|
|
<img
|
|
width="256px"
|
|
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
|
>
|
|
</picture>
|
|
<br>
|
|
<a href="https://revanced.app/">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
|
|
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://github.com/ReVanced">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
|
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="http://revanced.app/discord">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://reddit.com/r/revancedapp">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://t.me/app_revanced">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://x.com/revancedapp">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
|
|
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://www.youtube.com/@ReVanced">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
|
</picture>
|
|
</a>
|
|
<br>
|
|
<br>
|
|
Continuing the legacy of Vanced
|
|
</p>
|
|
|
|
# 👋 Contribution guidelines
|
|
|
|
This document describes how to contribute to ReVanced Patches.
|
|
|
|
## 📖 Resources to help you get started
|
|
|
|
* The [documentation](https://github.com/ReVanced/revanced-patcher/tree/main/docs) contains the fundamentals
|
|
of ReVanced Patcher and how to use ReVanced Patcher to create patches
|
|
* [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 feature request
|
|
|
|
Features can be requested by opening an issue using the
|
|
[Feature request issue template](https://github.com/ReVanced/revanced-patches/issues/new?assignees=&labels=Feature+request&projects=&template=feature_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+report&projects=&template=bug_report.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 [ReVanced Patcher documentation](https://github.com/ReVanced/revanced-patcher/tree/main/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
|