2023-10-21 11:38:29 +02:00
|
|
|
<p align="center">
|
|
|
|
|
<picture>
|
|
|
|
|
<source
|
|
|
|
|
width="256px"
|
|
|
|
|
media="(prefers-color-scheme: dark)"
|
|
|
|
|
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
|
|
|
|
>
|
|
|
|
|
<img
|
|
|
|
|
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
|
|
|
|
>
|
|
|
|
|
</picture>
|
|
|
|
|
<br>
|
|
|
|
|
<a href="https://revanced.app/">
|
|
|
|
|
<img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" />
|
|
|
|
|
</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">
|
|
|
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
|
|
|
|
</a>
|
|
|
|
|
<a href="https://reddit.com/r/revancedapp">
|
|
|
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
|
|
|
|
</a>
|
|
|
|
|
<a href="https://t.me/app_revanced">
|
|
|
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
|
|
|
|
</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">
|
|
|
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
|
|
|
|
</a>
|
|
|
|
|
<br>
|
|
|
|
|
<br>
|
|
|
|
|
Continuing the legacy of Vanced
|
|
|
|
|
</p>
|
|
|
|
|
|
2023-10-21 12:06:43 +02:00
|
|
|
# 👋 Contribution guidelines
|
2023-10-21 11:38:29 +02:00
|
|
|
This document describes how to contribute to ReVanced Manager.
|
|
|
|
|
|
|
|
|
|
## 📖 Resources to help you get started
|
2023-10-21 12:05:53 +02:00
|
|
|
* The [documentation](/docs/README.md) provides steps to build ReVanced Manager from source
|
2023-10-21 11:38:29 +02:00
|
|
|
* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
|
2023-10-21 11:58:45 +02:00
|
|
|
* [Issues](https://github.com/ReVanced/revanced-manager/issues) are where we keep track of bugs and feature requests
|
2023-10-21 11:38:29 +02:00
|
|
|
|
|
|
|
|
## 🙏 Submitting a feature request
|
|
|
|
|
Features can be requested by opening an issue using the
|
2023-10-21 12:11:43 +02:00
|
|
|
[Feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E).
|
2023-10-21 11:38:29 +02:00
|
|
|
|
|
|
|
|
> [!NOTE]
|
|
|
|
|
> We may rejected your request at the discretion of maintainers,
|
|
|
|
|
> please provides good motivation for a request to be accepted.
|
|
|
|
|
|
|
|
|
|
## 🐞 Submitting a bug report
|
|
|
|
|
If you encounter a bug while using the ReVanced Manager app, open an issue using the
|
2023-10-21 12:11:43 +02:00
|
|
|
[Bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E).
|
2023-10-21 11:38:29 +02:00
|
|
|
|
|
|
|
|
## 📝 How to contribute
|
|
|
|
|
> [!NOTE]
|
|
|
|
|
> It's worth noting that we recommended that you discuss your changes with
|
|
|
|
|
> the maintainers of ReVanced Manager before contributing.
|
|
|
|
|
> This will help you determine whether your change is acceptable.
|
|
|
|
|
|
|
|
|
|
1. Fork the repository and create your branch from `dev`
|
|
|
|
|
2. Make sure that the commit name are clear and concise as possible and commit your changes.
|
|
|
|
|
If you have never contributed to this repository before, it's recommended to follow the rules in the [documentation](/docs/README.md)
|
|
|
|
|
3. Open a pull request to the `dev` branch and reference issues with `fix: #No.` if needed.
|
|
|
|
|
4. The maintainers of ReVanced Manager will review and provide suggestions.
|
|
|
|
|
Once your PR is approved and merged, it will be included in the next release of ReVanced Manager
|
|
|
|
|
|
|
|
|
|
## 🤚 I want to contribute but don't know how to code
|
2023-10-21 11:58:45 +02:00
|
|
|
Even if you don't know how to code, you can still help us by
|
2023-10-21 12:05:53 +02:00
|
|
|
translate the ReVanced Manager application at Crowdin!
|
2023-10-21 11:38:29 +02:00
|
|
|
|
|
|
|
|
<!-- TODO: Crowdin after release!!! -->
|
|
|
|
|
|
|
|
|
|
❤️ Thank you for considering contributing to ReVanced Manager
|
