mirror of
https://github.com/ReVanced/revanced-manager.git
synced 2024-11-10 01:01:56 +01:00
docs: part 8.6
This commit is contained in:
parent
2f31fc7d6e
commit
0419b2f86b
6 changed files with 26 additions and 0 deletions
|
@ -44,14 +44,17 @@
|
|||
</p>
|
||||
|
||||
# 👋 Contribution guidelines
|
||||
|
||||
This document describes how to contribute to ReVanced Manager.
|
||||
|
||||
## 📖 Resources to help you get started
|
||||
|
||||
* The [documentation](/docs/README.md) provides steps to build ReVanced Manager from source
|
||||
* 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-manager/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-manager/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E).
|
||||
|
||||
|
@ -60,10 +63,12 @@ Features can be requested by opening an issue using the
|
|||
> please provide good motivation for a request to be accepted.
|
||||
|
||||
## 🐞 Submitting a bug report
|
||||
|
||||
If you encounter a bug while using the ReVanced Manager app, open an issue using the
|
||||
[bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E).
|
||||
|
||||
## 📝 How to contribute
|
||||
|
||||
> [!NOTE]
|
||||
> We recommend that you discuss your changes with
|
||||
> the maintainers of ReVanced Manager before contributing.
|
||||
|
@ -77,6 +82,7 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using
|
|||
Once your pull request is approved and merged, it will be included in the next release of ReVanced Manager
|
||||
|
||||
## 🤚 I want to contribute but don't know how to code
|
||||
|
||||
Even if you don't know how to code, you can still contribute by
|
||||
translating ReVanced Manager on [Crowdin](https://translate.revanced.app/).
|
||||
|
||||
|
|
|
@ -51,6 +51,7 @@
|
|||
ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications.
|
||||
|
||||
### 💪 Features
|
||||
|
||||
We provide the some of the features are:
|
||||
|
||||
* 📱 **Portable**: ReVanced Patcher that fit in your pocket!
|
||||
|
@ -59,18 +60,23 @@ We provide the some of the features are:
|
|||
* ✨ And a **lot more!**
|
||||
|
||||
### 🔽 Download
|
||||
|
||||
You can obtain ReVanced Manager by downloading it from either [ReVanced site](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases).
|
||||
|
||||
## 🌱 Miscellaneous
|
||||
|
||||
### 📄 Documentation
|
||||
|
||||
Documentation on how to use the application is available [here](/docs/README.md).
|
||||
|
||||
### 👋 Contributing
|
||||
|
||||
Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md).
|
||||
|
||||
### 🔴 Issues
|
||||
|
||||
For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose).
|
||||
|
||||
## ⚖️ License
|
||||
|
||||
ReVanced Manager adopts the [GNU General Public License 3.0](/LICENSE), [tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3): You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
|
||||
|
|
|
@ -14,6 +14,7 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV
|
|||
3. [❔ Troubleshooting](3_troubleshooting.md)
|
||||
|
||||
## 👋 Developer version
|
||||
|
||||
Interested in contributing? Consider checking out the developer [documentation](/developers/README.md)
|
||||
|
||||
## ⏭️ Start here
|
||||
|
|
|
@ -1,12 +1,15 @@
|
|||
# 💼 Preparing a development environment
|
||||
|
||||
In order to compile ReVanced Manager, certain requirements must be met.
|
||||
|
||||
## 📝 Prerequisites
|
||||
|
||||
* Kotlin IDE such as [Android Studio](https://developer.android.com/studio)
|
||||
* Knowledge of [Android](https://android.com) app development, and the [Kotlin](https://kotlinlang.org/) language.
|
||||
* At least JDK 17 of any vendors
|
||||
|
||||
## 🏃 Prepare the environment
|
||||
|
||||
1. Clone the repository
|
||||
```sh
|
||||
git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager
|
||||
|
@ -17,6 +20,7 @@ In order to compile ReVanced Manager, certain requirements must be met.
|
|||
```
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will introduce you to the basic overview of ReVanced Manager
|
||||
|
||||
Continue: [💁 Overview](1_overview.md)
|
||||
|
|
|
@ -1,24 +1,30 @@
|
|||
# 💁 Overview
|
||||
|
||||
Take a quick peak of how ReVanced Compose work.
|
||||
|
||||
## ⚙️ Technology
|
||||
|
||||
We use [Jetpack Compose](https://developer.android.com/jetpack/compose) 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.
|
||||
|
||||
## 📂 Structure
|
||||
|
||||
We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code.
|
||||
|
||||
## 🧑💻 Code readability
|
||||
|
||||
In order to maintain readability of the code, It's highly recommend that you follow
|
||||
https://developer.android.com/jetpack/compose/api-guidelines style guide to maintain
|
||||
consistent style through out the codebase.
|
||||
|
||||
## 🎨 Design language
|
||||
|
||||
We adopt the [Material Design 3](https://m3.material.io) as our design language to
|
||||
bring friendly, intuitive and colourful UI to our application ensuring that the
|
||||
app's user interface is consistent, customizable, accessible, and engaging for our users.
|
||||
|
||||
## 📃 Commit message
|
||||
|
||||
At ReVanced, we follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0)
|
||||
format for our commit message.
|
||||
|
|
|
@ -1,11 +1,14 @@
|
|||
# 💊 ReVanced Manager
|
||||
|
||||
This documentation explains how [ReVanced Manager](https://github.com/ReVanced/revanced-manager) works.
|
||||
|
||||
## 📖 Table of contents
|
||||
|
||||
0. [💼 Preparing a development environment](0_preparation.md)
|
||||
1. [💁 Overview](1_overview.md)
|
||||
|
||||
## ⏭️ Start here
|
||||
|
||||
The next page will tell you how to prepare a development environment for ReVanced Manager.
|
||||
|
||||
Continue: [💼 Preparing a development environment](0_preparation.md)
|
||||
|
|
Loading…
Reference in a new issue