revanced-cli/CONTRIBUTING.md

99 lines
4.9 KiB
Markdown
Raw Normal View History

2023-09-22 03:31:32 +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-11-22 23:32:52 +01:00
width="256px"
2023-09-22 03:31:32 +02:00
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
>
</picture>
<br>
<a href="https://revanced.app/">
2023-11-22 23:32:52 +01: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-09-22 03:31:32 +02:00
</a>&nbsp;&nbsp;&nbsp;
2023-11-22 23:32:52 +01:00
<a href="https://github.com/ReVanced">
2023-09-22 03:31:32 +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">
2023-11-22 23:32:52 +01: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-09-22 03:31:32 +02:00
</a>&nbsp;&nbsp;&nbsp;
<a href="https://reddit.com/r/revancedapp">
2023-11-22 23:32:52 +01: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-09-22 03:31:32 +02:00
</a>&nbsp;&nbsp;&nbsp;
<a href="https://t.me/app_revanced">
2023-11-22 23:32:52 +01: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-09-22 03:31:32 +02:00
</a>&nbsp;&nbsp;&nbsp;
2023-11-22 23:32:52 +01:00
<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>
2023-09-22 03:31:32 +02:00
</a>&nbsp;&nbsp;&nbsp;
<a href="https://www.youtube.com/@ReVanced">
2023-11-22 23:32:52 +01: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>
</a>
2023-09-22 03:31:32 +02:00
<br>
<br>
Continuing the legacy of Vanced
</p>
2023-10-21 12:07:40 +02:00
# 👋 Contribution guidelines
2023-09-22 03:31:32 +02:00
This document describes how to contribute to ReVanced CLI.
## 📖 Resources to help you get started
2024-02-23 03:03:51 +01:00
- The [documentation](/docs) explains how to use ReVanced CLI
- [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-cli/issues) are where we keep track of bugs and feature requests
2023-09-22 03:31:32 +02:00
## 🙏 Submitting a feature request
Features can be requested by opening an issue using the
2024-02-26 04:37:46 +01:00
[Feature request issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+).
2023-09-22 03:31:32 +02:00
> **Note**
> Requests can be accepted or rejected at the discretion of maintainers of ReVanced CLI.
> Good motivation has to be provided for a request to be accepted.
## 🐞 Submitting a bug report
If you encounter a bug while using ReVanced CLI, open an issue using the
2024-02-26 04:37:46 +01:00
[Bug report issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+).
2023-09-22 03:31:32 +02:00
## 📝 How to contribute
1. Before contributing, it is recommended to open an issue to discuss your change
with the maintainers of ReVanced CLI. 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`
2024-02-23 03:00:35 +01:00
3. Commit your changes
2023-09-22 03:31:32 +02:00
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 CLI
2024-02-23 03:03:51 +01:00
❤️ Thank you for considering contributing to ReVanced CLI,
2023-10-21 12:07:40 +02:00
ReVanced