Skip to content

Commit 68f74f1

Browse files
committed
docs: Add contribution guidelines and adjust README
1 parent 6264800 commit 68f74f1

File tree

3 files changed

+129
-54
lines changed

3 files changed

+129
-54
lines changed

β€ŽSECURITY.mdβ€Ž renamed to β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,20 +58,46 @@
5858
Continuing the legacy of Vanced
5959
</p>
6060

61-
# πŸ”’ Security Policy
61+
# πŸ‘‹ Contribution guidelines
6262

63-
This document describes how to report security vulnerabilities for ReVanced Manager.
63+
This document describes how to contribute to ReVanced Manager.
6464

65-
## 🚨 Reporting a Vulnerability
65+
## πŸ“– Resources to help you get started
6666

67-
Please open an issue in our [advisory tracker](https://github.com/ReVanced/revanced-manager/security/advisories/new) or reach out privately to us on [Discord](https://discord.gg/revanced).
67+
* The [documentation](/docs/README.md) provides steps to build ReVanced Manager from source
68+
* Our [backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
69+
* [Issues](https://github.com/ReVanced/revanced-manager/issues) are where we keep track of bugs and feature requests
6870

69-
If a vulnerability is confirmed and accepted, you can join our [Discord](https://discord.gg/revanced) server to receive a special contributor role.
71+
## πŸ™ Submitting a feature request
7072

71-
### ⏳ Supported Versions
73+
Features can be requested by opening an issue using the
74+
[Feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+).
7275

73-
| Version | Branch | Supported |
74-
| --------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------ |
75-
| ![Latest stable release](https://img.shields.io/github/v/release/ReVanced/revanced-manager?style=for-the-badge "Latest stable release") | main | :white_check_mark: |
76-
| ![Latest version](https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version") | dev | :white_check_mark: |
77-
| ![Latest version](https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version") | compose-dev | :white_check_mark: |
76+
> **Note**
77+
> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Manager.
78+
> Good motivation has to be provided for a request to be accepted.
79+
80+
## 🐞 Submitting a bug report
81+
82+
If you encounter a bug while using ReVanced Manager, open an issue using the
83+
[Bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+).
84+
85+
## πŸ“ How to contribute
86+
87+
1. Before contributing, it is recommended to open an issue to discuss your change
88+
with the maintainers of ReVanced Manager. This will help you determine whether your change is acceptable
89+
and whether it is worth your time to implement it
90+
2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev`
91+
3. Commit your changes
92+
4. Submit a pull request to the `dev` branch of the repository and reference issues
93+
that your pull request closes in the description of your pull request
94+
5. Our team will review your pull request and provide feedback. Once your pull request is approved,
95+
it will be merged into the `dev` branch and will be included in the next release of ReVanced Manager
96+
97+
## 🀚 I want to contribute but don't know how to code
98+
99+
Even if you don't know how to code, you can still contribute by
100+
translating ReVanced Manager on [Crowdin](https://translate.revanced.app/).
101+
102+
❀️ Thank you for considering contributing to ReVanced Manager,
103+
ReVanced

β€ŽREADME.mdβ€Ž

Lines changed: 92 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,104 @@
1-
# ReVanced Manager (Compose Rewrite)
2-
3-
[![GitHub license](https://img.shields.io/github/license/revanced/revanced-manager)](../../blob/main/LICENSE)
4-
[![GitHub last commit](https://img.shields.io/github/last-commit/revanced/revanced-manager/compose-dev)](https://github.com/ReVanced/revanced-manager/commits/compose-dev)
5-
[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/revanced/revanced-manager/compose-dev)](https://github.com/ReVanced/revanced-manager/commits/compose-dev)
6-
7-
_(Yet another)_ rewrite of the ReVanced Manager using Kotlin and Jetpack Compose.
8-
9-
## Design system
10-
11-
In this rewrite, we are adopting the latest Material Design principles and guidelines by using Material 3 and Material You.
12-
13-
Material Design is a design system developed by Google that provides a unified visual language for building beautiful and consistent user interfaces across all platforms and devices. Material You is an extension of Material Design that provides even more customization options for users, making it possible for them to personalize their device and create a unique look and feel.
14-
15-
### Why Material 3?
16-
17-
* **Consistent design language**
18-
* **Improved accessibility**
19-
* **Better user experience**
20-
21-
By using Material 3 and Material You, we are ensuring that the app's user interface is consistent, customizable, accessible, and engaging for our users. This will help to improve the overall user experience and increase user satisfaction with the the manager.
22-
23-
## Technology stack
24-
25-
* Kotlin: Kotlin is a modern and concise programming language that is fully interoperable with Java and provides improved safety, readability, and maintainability compared to Java.
26-
* Jetpack Compose: Jetpack Compose is a modern UI toolkit for Android development that allows developers to build beautiful and performant user interfaces using declarative programming. It provides a unified and efficient way of building UI that is well-integrated with the Android framework.
27-
28-
## Why Kotlin and Compose?
29-
30-
* **Improved safety:** Kotlin provides improved safety compared to Java, which reduces the likelihood of common programming mistakes that can cause security vulnerabilities or crashes.
31-
* **Concise and readable code:** Kotlin's concise syntax and expressive type system make the code more readable, which makes it easier for developers to understand and maintain the codebase.
32-
* **Better performance:** Jetpack Compose uses the power of the Android framework to provide smooth and fast performance, which enhances the user experience.
33-
* **Modern and efficient UI development:** Jetpack Compose provides a modern and efficient way of building UI, which makes it easier for developers to create beautiful and performant user interfaces.
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>&nbsp;&nbsp;&nbsp;
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>&nbsp;&nbsp;&nbsp;
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>&nbsp;&nbsp;&nbsp;
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>&nbsp;&nbsp;&nbsp;
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>&nbsp;&nbsp;&nbsp;
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>&nbsp;&nbsp;&nbsp;
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+
# πŸ’Š ReVanced Manager
62+
63+
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-manager/release.yml)
64+
![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)
65+
66+
Application to use ReVanced on Android
67+
68+
## ❓ About
69+
70+
ReVanced Manager is an application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps.
71+
72+
## πŸ’ͺ Features
73+
74+
Some of the features ReVanced Manager provides are:
75+
76+
- ⬇️ **Download**: Automatically download apps using the ReVanced Manager downloader plugin system
77+
- πŸ’‰ **Patch**: Select and apply patches to any Android app
78+
- πŸ› οΈ **Customize**: Manage patches, apps, signing, themes, updates, and many more settings
3479

3580
## πŸ”½ Download
3681

37-
You can obtain ReVanced Manager by downloading it from either [revanced.app/download](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases)
82+
You can download the most recent version of ReVanced Manager at [revanced.app/download](https://revanced.app/download) or from [GitHub releases](https://github.com/ReVanced/revanced-manager/releases/latest).
83+
Learn how to use ReVanced Manager by following the [documentation](/docs).
3884

39-
## πŸ“ Prerequisites
85+
## πŸ“š Everything else
4086

41-
For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md)
87+
### πŸ“™ Contributing
4288

43-
## πŸ”΄ Issues
89+
Thank you for considering contributing to ReVanced Manager.
90+
You can find the contribution guidelines [here](CONTRIBUTING.md).
4491

45-
For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose).
92+
### πŸ› οΈ Building
4693

47-
## 🌐 Translation
94+
To build a ReVanced Manager, you can follow the [documentation](/docs).
4895

49-
[![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](https://crowdin.com/project/revanced)
96+
### πŸ“„ Documentation
5097

51-
We're accepting translations on [Crowdin](https://translate.revanced.app)
98+
You can find the documentation for ReVanced Manager [here](/docs).
5299

53-
## πŸ› οΈ Building Manager from source
100+
## βš–οΈ License
54101

55-
For instructions on how to build ReVanced Manager from source, refer to [docs/4_building.md](docs/4_building.md)
102+
ReVanced Manager is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
103+
[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Manager as long as you track changes/dates in source files.
104+
Any modifications to ReVanced Manager must also be made available under the GPL, along with build & install instructions.

0 commit comments

Comments
Β (0)