mirror of
https://github.com/revanced/revanced-cli.git
synced 2024-11-03 18:33:55 +01:00
79 lines
3.7 KiB
Markdown
79 lines
3.7 KiB
Markdown
|
<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://twitter.com/revancedapp">
|
||
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032018-6da37214-7474-4641-a1da-7af7db3a31cd.png" />
|
||
|
|
</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>
|
||
|
|
|
||
|
|
# 📙 ReVanced CLI contribution guidelines
|
||
|
|
|
||
|
|
This document describes how to contribute to ReVanced CLI.
|
||
|
|
|
||
|
|
## 📖 Resources to help you get started
|
||
|
|
|
||
|
|
* 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
|
||
|
|
|
||
|
|
## 🙏 Submitting a feature request
|
||
|
|
|
||
|
|
Features can be requested by opening an issue using the
|
||
|
|
[Feature request issue template](https://github.com/ReVanced/revanced-cli/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 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
|
||
|
|
[Bug report issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Bug+report&projects=&template=bug-report.yml&title=bug%3A+).
|
||
|
|
|
||
|
|
## 📝 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`
|
||
|
|
3. Commit your changes.
|
||
|
|
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
|
||
|
|
|
||
|
|
❤️ Thank you for considering contributing to ReVanced CLI,
|
||
|
|
ReVanced
|