|
| 1 | +<p align="center"> |
| 2 | + <picture> |
| 3 | + <source |
| 4 | + width="256px" |
| 5 | + media="(prefers-color-scheme: dark)" |
| 6 | + srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" |
| 7 | + > |
| 8 | + <img |
| 9 | + width="256px" |
| 10 | + src="assets/revanced-headline/revanced-headline-vertical-light.svg" |
| 11 | + > |
| 12 | + </picture> |
| 13 | + <br> |
| 14 | + <a href="https://revanced.app/"> |
| 15 | + <picture> |
| 16 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" /> |
| 17 | + <img height="24px" src="assets/revanced-logo/revanced-logo.svg" /> |
| 18 | + </picture> |
| 19 | + </a> |
| 20 | + <a href="https://github.com/ReVanced"> |
| 21 | + <picture> |
| 22 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" /> |
| 23 | + <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" /> |
| 24 | + </picture> |
| 25 | + </a> |
| 26 | + <a href="http://revanced.app/discord"> |
| 27 | + <picture> |
| 28 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> |
| 29 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> |
| 30 | + </picture> |
| 31 | + </a> |
| 32 | + <a href="https://reddit.com/r/revancedapp"> |
| 33 | + <picture> |
| 34 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> |
| 35 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> |
| 36 | + </picture> |
| 37 | + </a> |
| 38 | + <a href="https://t.me/app_revanced"> |
| 39 | + <picture> |
| 40 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> |
| 41 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> |
| 42 | + </picture> |
| 43 | + </a> |
| 44 | + <a href="https://x.com/revancedapp"> |
| 45 | + <picture> |
| 46 | + <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png"> |
| 47 | + <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" /> |
| 48 | + </picture> |
| 49 | + </a> |
| 50 | + <a href="https://www.youtube.com/@ReVanced"> |
| 51 | + <picture> |
| 52 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> |
| 53 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> |
| 54 | + </picture> |
| 55 | + </a> |
| 56 | + <br> |
| 57 | + <br> |
| 58 | + Continuing the legacy of Vanced |
| 59 | +</p> |
| 60 | + |
| 61 | +# 👋 Contribution guidelines |
| 62 | + |
| 63 | +This document describes how to contribute to ReVanced API. |
| 64 | + |
| 65 | +## 📖 Resources to help you get started |
| 66 | + |
| 67 | +* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on |
| 68 | +* [Issues](https://github.com/ReVanced/revanced-api/issues) are where we keep track of bugs and feature requests |
| 69 | + |
| 70 | +## 🙏 Submitting a feature request |
| 71 | + |
| 72 | +Features can be requested by opening an issue using the |
| 73 | +[Feature request issue template](https://github.com/ReVanced/revanced-api/issues/new?assignees=&labels=Feature+request&projects=&template=feature-request.yml&title=feat%3A+). |
| 74 | + |
| 75 | +> **Note** |
| 76 | +> Requests can be accepted or rejected at the discretion of maintainers of ReVanced API. |
| 77 | +> Good motivation has to be provided for a request to be accepted. |
| 78 | +
|
| 79 | +## 🐞 Submitting a bug report |
| 80 | + |
| 81 | +If you encounter a bug while using ReVanced API, open an issue using the |
| 82 | +[Bug report issue template](https://github.com/ReVanced/revanced-api/issues/new?assignees=&labels=Bug+report&projects=&template=bug-report.yml&title=bug%3A+). |
| 83 | + |
| 84 | +## 📝 How to contribute |
| 85 | + |
| 86 | +1. Before contributing, it is recommended to open an issue to discuss your change |
| 87 | +with the maintainers of ReVanced API. This will help you determine whether your change is acceptable |
| 88 | +and whether it is worth your time to implement it |
| 89 | +2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev` |
| 90 | +3. Commit your changes |
| 91 | +4. Submit a pull request to the `dev` branch of the repository and reference issues |
| 92 | +that your pull request closes in the description of your pull request |
| 93 | +5. Our team will review your pull request and provide feedback. Once your pull request is approved, |
| 94 | +it will be merged into the `dev` branch and will be included in the next release of ReVanced API |
| 95 | + |
| 96 | +❤️ Thank you for considering contributing to ReVanced API, |
| 97 | +ReVanced |
0 commit comments