-
-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add README and repository configuration files (#269)
Co-authored-by: Ushie <[email protected]>
- Loading branch information
Showing
10 changed files
with
427 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
name: π Bug report | ||
description: Report a bug or an issue. | ||
title: 'bug: ' | ||
labels: ['Bug report'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
<p align="center"> | ||
<picture> | ||
<source | ||
width="256px" | ||
media="(prefers-color-scheme: dark)" | ||
srcset="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-headline/revanced-headline-vertical-dark.svg" | ||
> | ||
<img | ||
width="256px" | ||
src="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-headline/revanced-headline-vertical-light.svg" | ||
> | ||
</picture> | ||
<br> | ||
<a href="https://revanced.app/"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-logo/revanced-logo.svg" /> | ||
<img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-logo/revanced-logo.svg" /> | ||
</picture> | ||
</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"> | ||
<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> | ||
</a> | ||
<a href="https://reddit.com/r/revancedapp"> | ||
<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> | ||
</a> | ||
<a href="https://t.me/app_revanced"> | ||
<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> | ||
</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"> | ||
<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> | ||
<br> | ||
<br> | ||
Continuing the legacy of Vanced | ||
</p> | ||
# ReVanced Website bug report | ||
Before creating a new bug report, please keep the following in mind: | ||
- **Do not submit a duplicate bug report**: Search for existing bug reports [here](https://github.com/ReVanced/revanced-website/issues?q=label%3A%22Bug+report%22). | ||
- **Review the contribution guidelines**: Make sure your bug report adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-website/blob/main/CONTRIBUTING.md). | ||
- **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app). | ||
- type: textarea | ||
attributes: | ||
label: Bug description | ||
description: | | ||
- Describe your bug in detail | ||
- Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...) | ||
- Add images and videos if possible | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Error logs | ||
description: Exceptions that unexpectedly happened during the development or production status of the website. | ||
render: shell | ||
- type: textarea | ||
attributes: | ||
label: Solution | ||
description: If applicable, add a possible solution to the bug. | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: Add additional context here. | ||
- type: checkboxes | ||
id: acknowledgements | ||
attributes: | ||
label: Acknowledgements | ||
description: Your bug report will be closed if you don't follow the checklist below. | ||
options: | ||
- label: I have checked all open and closed bug reports and this is not a duplicate. | ||
required: true | ||
- label: I have chosen an appropriate title. | ||
required: true | ||
- label: All requested information has been provided properly. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: π¨ Discussions | ||
url: https://github.com/revanced/revanced-suggestions/discussions | ||
about: Have something unspecific to ReVanced Website in mind? Search for or start a new discussion! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
name: β Feature request | ||
description: Create a detailed request for a new feature. | ||
title: 'feat: ' | ||
labels: ['Feature request'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
<p align="center"> | ||
<picture> | ||
<source | ||
width="256px" | ||
media="(prefers-color-scheme: dark)" | ||
srcset="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-headline/revanced-headline-vertical-dark.svg" | ||
> | ||
<img | ||
width="256px" | ||
src="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-headline/revanced-headline-vertical-light.svg" | ||
> | ||
</picture> | ||
<br> | ||
<a href="https://revanced.app/"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-logo/revanced-logo.svg" /> | ||
<img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-website/main/assets/revanced-logo/revanced-logo.svg" /> | ||
</picture> | ||
</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"> | ||
<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> | ||
</a> | ||
<a href="https://reddit.com/r/revancedapp"> | ||
<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> | ||
</a> | ||
<a href="https://t.me/app_revanced"> | ||
<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> | ||
</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"> | ||
<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> | ||
<br> | ||
<br> | ||
Continuing the legacy of Vanced | ||
</p> | ||
# ReVanced Website feature request | ||
Before creating a new feature request, please keep the following in mind: | ||
- **Do not submit a duplicate feature request**: Search for existing feature requests [here](https://github.com/ReVanced/revanced-website/issues?q=label%3A%22Feature+request%22). | ||
- **Review the contribution guidelines**: Make sure your feature request adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-website/blob/main/CONTRIBUTING.md). | ||
- **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app). | ||
- type: textarea | ||
attributes: | ||
label: Feature description | ||
description: | | ||
- Describe your feature in detail | ||
- Add images, videos, links, examples, references, etc. if possible | ||
- type: textarea | ||
attributes: | ||
label: Motivation | ||
description: | | ||
A strong motivation is necessary for a feature request to be considered. | ||
- Why should this feature be implemented? | ||
- What is the explicit use case? | ||
- What are the benefits? | ||
- What makes this feature important? | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: acknowledgements | ||
attributes: | ||
label: Acknowledgements | ||
description: Your feature request will be closed if you don't follow the checklist below. | ||
options: | ||
- label: I have checked all open and closed feature requests and this is not a duplicate | ||
required: true | ||
- label: I have chosen an appropriate title. | ||
required: true | ||
- label: All requested information has been provided properly. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
firstPRMergeComment: > | ||
Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) to receive a role for your contribution. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: npm | ||
labels: [] | ||
directory: / | ||
target-branch: dev | ||
schedule: | ||
interval: monthly |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
<p align="center"> | ||
<picture> | ||
<source | ||
width="256px" | ||
media="(prefers-color-scheme: dark)" | ||
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" | ||
> | ||
<img | ||
width="256px" | ||
src="assets/revanced-headline/revanced-headline-vertical-light.svg" | ||
> | ||
</picture> | ||
<br> | ||
<a href="https://revanced.app/"> | ||
<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> | ||
</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"> | ||
<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> | ||
</a> | ||
<a href="https://reddit.com/r/revancedapp"> | ||
<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> | ||
</a> | ||
<a href="https://t.me/app_revanced"> | ||
<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> | ||
</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"> | ||
<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> | ||
<br> | ||
<br> | ||
Continuing the legacy of Vanced | ||
</p> | ||
|
||
# π Contribution guidelines | ||
|
||
This document describes how to contribute to ReVanced Website. | ||
|
||
## π Resources to help you get started | ||
|
||
* 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-website/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-website/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E). | ||
|
||
> [!NOTE] | ||
> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Website. | ||
> Good motivation has to be provided for a request to be accepted. | ||
## π Submitting a bug report | ||
|
||
If you encounter a bug while using the ReVanced Website, open an issue using the | ||
[bug report issue template](https://github.com/ReVanced/revanced-website/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). | ||
|
||
## π How to contribute | ||
|
||
1. Before contributing, it is recommended to open an issue to discuss your change | ||
with the maintainers of ReVanced Website. 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 Website | ||
|
||
β€οΈ Thank you for considering contributing to ReVanced Website, | ||
ReVanced |
Oops, something went wrong.