revanced-manager/CONTRIBUTING.md

107 lines
5.3 KiB
Markdown
Raw Permalink Normal View History

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
2023-10-21 12:21:21 +02:00
width="256px"
2023-10-21 11:38:29 +02:00
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
>
</picture>
<br>
<a href="https://revanced.app/">
2024-08-18 15:01:45 +02:00
<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>
2023-10-21 11:38:29 +02:00
</a>&nbsp;&nbsp;&nbsp;
2023-10-21 14:54:44 +02:00
<a href="https://github.com/ReVanced">
2023-10-21 11:38:29 +02:00
<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>&nbsp;&nbsp;&nbsp;
<a href="http://revanced.app/discord">
2024-08-18 15:01:45 +02:00
<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>
2023-10-21 11:38:29 +02:00
</a>&nbsp;&nbsp;&nbsp;
<a href="https://reddit.com/r/revancedapp">
2024-08-18 15:01:45 +02:00
<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>
2023-10-21 11:38:29 +02:00
</a>&nbsp;&nbsp;&nbsp;
<a href="https://t.me/app_revanced">
2024-08-18 15:01:45 +02:00
<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>
2023-10-21 11:38:29 +02:00
</a>&nbsp;&nbsp;&nbsp;
<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>&nbsp;&nbsp;&nbsp;
<a href="https://www.youtube.com/@ReVanced">
2024-08-18 15:01:45 +02:00
<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>
2023-10-21 11:38:29 +02:00
</a>
<br>
<br>
Continuing the legacy of Vanced
</p>
2023-10-21 12:06:43 +02:00
# 👋 Contribution guidelines
2023-10-23 10:16:34 +02:00
2024-08-18 15:41:45 +02:00
Welcome to contribution guidelines, this document contains
everything you'll need to contribute to ReVanced Manager.
2023-10-21 11:38:29 +02:00
## 📖 Resources to help you get started
2023-10-23 10:16:34 +02:00
2023-10-21 12:05:53 +02:00
* The [documentation](/docs/README.md) provides steps to build ReVanced Manager from source
* 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
2023-10-23 10:16:34 +02:00
2023-10-21 11:38:29 +02:00
Features can be requested by opening an issue using the
[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]
2024-08-18 15:41:45 +02:00
> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Manager.
> Good motivation has to be provided for a request to be accepted.
2023-10-21 11:38:29 +02:00
## 🐞 Submitting a bug report
2023-10-23 10:16:34 +02:00
2023-10-21 11:38:29 +02:00
If you encounter a bug while using the ReVanced Manager app, open an issue using the
[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
2023-10-23 10:16:34 +02:00
2024-08-18 15:41:45 +02:00
> [!TIP]
> We recommend that you discuss your changes with
2023-10-21 11:38:29 +02:00
> the maintainers of ReVanced Manager before contributing.
> This will help you determine whether your change is acceptable.
2024-08-18 15:41:45 +02:00
1. Fork the repository and create your branch from `dev`
2. Commit your changes
3. 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
4. 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 Manager
2023-10-21 11:38:29 +02:00
## 🤚 I want to contribute but don't know how to code
2023-10-23 10:16:34 +02:00
Even if you don't know how to code, you can still contribute by
2024-08-18 15:41:45 +02:00
translating ReVanced Manager on [Crowdin](https://translate.revanced.app/)
2024-08-18 15:43:29 +02:00
or sponsor us at [GitHub Sponsor](https://github.com/sponsors/ReVanced) and [Open Collective](https://opencollective.com/ReVanced).
2023-10-21 11:38:29 +02:00
2024-08-18 15:41:45 +02:00
❤️ Thank you for considering contributing to ReVanced Manager,
ReVanced