### CONTRIBUTING

Amaze was created with a vision to provide all the basic and advanced features a file manager in Android is supposed to have, with a friendly material design.
As with any other open source project, contributions are the key to achieve this goal of ours.

Contributions are always welcome!

To start contributing, we assume you know how to use git and write and debug Android apps - don't expect we can teach you ;)

Please keep in mind the points below before considering contributing to Amaze:
- Make sure to write your name and Email-ID in format ````Name<email>```` in the license declaration above every file you make change to.
You won't be able to claim the license for changes made by you unless you do that. 
If there's no license header in any file, please include one from [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) webpage.
- Please follow [Android/JAVA code style](https://source.android.com/source/code-style.html) for writing any code, but do not use the Hungarian notation proposed - discussion [here](https://github.com/TeamAmaze/AmazeFileManager/issues/986). 
Also, follow [Android Material Design guidelines](https://m3.material.io/get-started) in case you make changes to any UI element.
- To file a bug report, it is recommended to include the steps to reproduce it; and even better, it helps us a lot if you can capture the error messages in logcat too 
It is also recommended to enroll to our beta program from Play Store to test and verify any fix for the same.

We work with pull requests, so, for improvements, new features or bugfixes, please submit your changes as pull requests.
We will then:

1. start review of your code for cleanliness and robustness
2. test them to see if they work as you said
3. merge the pull request

To speed up the review process, please:

- write your code cleanly. We also have our day time work, we are not able to correct the mistakes in your code.
- before opening PR, run `./gradlew spotlessCheck` and `./gradlew spotlessApply` in your local to check / fix any formatting issues.
- describe clearly what your pull request does
- if you're fixing a particular bug in the issue list, please explicitly say "Fixes #<issue number>" in your description
- once you've opened PR, look out for CI builds, if there is any code smell / bug - CI will complain, please work on it to keep the code clean.
- while not required (because automated tests can't test everything), it's recommended you to include [Robolectric](http://robolectric.org/)/[Espresso](https://developer.android.com/training/testing/espresso/) tests in your pull request

Finally:

- we have our day time work, so except security vulnerabilities, your submission may be left cold for a couple of days before being picked up by us
- it's good to start a new branch to start your work. Not just for a shiny branch name, but also for your own good
- we can be harsh when reviewing your work but because we want to have good code in our codebase. Be patient and carefully read our comments
- we can be wrong. Again, be patient when discuss with us - we accept reason, but we never accept hate speech

If we feel your PR is a significant help to us, we'll award you a bounty with any of your preferred mode of payment.  
Please provide the details for the same once asked.
Ready to roll? Start forking ;)

---

### README

[](https://app.codacy.com/gh/TeamAmaze/AmazeFileManager?utm_source=github.com&utm_medium=referral&utm_content=TeamAmaze/AmazeFileManager&utm_campaign=Badge_Grade_Settings)
[](https://www.codacy.com/gh/TeamAmaze/AmazeFileManager?utm_source=github.com&utm_medium=referral&utm_content=TeamAmaze/AmazeFileManager&utm_campaign=Badge_Coverage)
[](https://www.appbrain.com/app/amaze-file-manager/com.amaze.filemanager)
[](https://github.com/TeamAmaze/AmazeFileManager/releases)
[](https://apt.izzysoft.de/fdroid/index/apk/com.amaze.filemanager)  
[](https://t.me/AmazeFileManager)
[](http://forum.xda-developers.com/android/apps-games/app-amaze-file-managermaterial-theme-t2937314)  
[](https://liberapay.com/Team-Amaze/donate)  

# <a href="https://teamamaze.xyz">Amaze File Manager</a>

Simple and attractive Material Design file manager for Android

Overview
---

<img src="icon.png" align="right" width="40%" height="100%"></img>

<div style="display:flex;">
    
- Open Source, light and smooth
- Based on Material Design guidelines
- Basic features like cut, copy, delete, compress, extract etc. easily accessible
- Work on multiple tabs at same time
- Multiple themes with cool icons
- Navigation drawer for quick navigation
- App Manager to open, backup, or directly uninstall any app
- Quickly access history, access bookmarks or search for any file
- Root explorer for advanced users
- AES Encryption and Decryption of files for security (Jellybean v4.3+)
- Cloud services support (Jellybean v4.3+ / requires additional plug-in)
- Inbuilt Database Reader, Zip/Rar Reader, Apk Reader, Text Reader
- No ads or In-app purchases
- lots more...

</div>

Downloads
---

[<img alt="Get it on Google Play" height="80" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png">](https://play.google.com/store/apps/details?id=com.amaze.filemanager)
[<img alt="Get it on F-Droid" height="80" src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png">](https://f-droid.org/packages/com.amaze.filemanager/)
[<img alt="Get it on IzzyOnDroid" height="80" src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png">](https://apt.izzysoft.de/fdroid/index/apk/com.amaze.filemanager)
[<img alt="Get it on GitHub" height="80" src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png">](https://github.com/TeamAmaze/AmazeFileManager/releases/latest)
[<img alt="Get it on AFH" height="50px" src="https://www.androidfilehost.com/images/afh.png">](https://www.androidfilehost.com/?w=files&flid=73967)

Contribute
---
You can contribute via one of the following ways:
- Help us with the translations of either [Amaze File Manager](https://app.transifex.com/amaze/amaze-file-manager) or [Amaze Utilities](https://crowdin.com/project/amaze-file-utilities)
- [Contribute](https://github.com/TeamAmaze/AmazeFileManager/blob/release/4.0/CONTRIBUTING.md) directly to the code, help us in fixing the bugs / implement new features.

_If we feel your contribution is a significant help to us, we'll award you a bounty with any of your preferred mode of payment._

Support
---
<a href="https://opencollective.com/TeamAmaze"><img width="20%" alt="OpenCollective" src="opencollective.svg" ></a>
<a href="https://www.paypal.me/vishalnehra"><img width="20%" src="paypal.svg" alt="PayPal"></a>
<a href="https://liberapay.com/Team-Amaze/donate"><img src="https://upload.wikimedia.org/wikipedia/commons/2/27/Liberapay_logo_v2_white-on-yellow.svg" alt="Liberapay" width="80px" ></a>  
Or buy the [Cloud Plugin](https://play.google.com/store/apps/details?id=com.filemanager.amazecloud) supports Google Drive™, Dropbox, OneDrive and Box accounts.  
Try our app - [Amaze File Utilities](https://play.google.com/store/apps/details?id=com.amaze.fileutilities) ([Fdroid](https://f-droid.org/en/packages/com.amaze.fileutilities/))
1. List videos / images / music documents in your device in a interactive UI where you're able to group / sort and quickly jump to any headers.
2. Open videos / images / music / documents (pdf / docx / epub) with inbuilt player.
3. Share / delete / cast on your tv
4. Analyse internal storage for junk files, duplicate files, large videos / old downloads / screenshots or recordings.
5. Analyse and group images between memes, low light / blurry / selfies / group pics.
7. Transfer files directly between two mobile devices on same wifi network using high speed peer to peer network
8. Gesture support in image / video player, play in background, picture in picture mode, download subtitles within the player.

Warning
---

Basic r/w operations might not work on external memory on Kitkat devices. Don't use cut/paste from or to external SD Card. You might lose your files.

***Under the license we are not responsible for damages.***

See our [Privacy Policy](https://github.com/TeamAmaze/AmazeFileManager/wiki/Privacy-Policy)

Vendors/Developers
----
The device vendors/ROM developers are free to include Amaze apk pre-installed in system. There is no fee required; *but you must comply with the license* (for more information read the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) or newer).

We strongly recommend using apk signed by us (either Play Store version or from AFH link above) so that users would be able to update directly from Play Store after distribution. Furthermore, a change in digital signature will break plug-ins.

### License: 

    Copyright (C) 2014-2018 Arpit Khurana <arpitkh96@gmail.com>
    Copyright (C) 2014-2024 Vishal Nehra <vishalmeham2@gmail.com>
    Copyright (C) 2017-2024 Emmanuel Messulam <emmanuelbendavid@gmail.com>
    Copyright (C) 2018-2024 Raymond Lai <airwave209gt at gmail.com>
    Copyright (C) 2019-2024 Vishnu Sanal T <t.v.s10123 at gmail.com>
    This file is part of Amaze File Manager.
    Amaze File Manager is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

---

### SECURITY

# Security Policy

## Supported Versions

`v3.8.5` supports Android 4.0 and above.
`v4.x.x` would only support Android 4.4 and above.

Android devices that runs Android versions less that Android 4.4
(Android KitKat) would not receive any more updates (the latest
supported version would be `v3.8.5`).

## Reporting a Vulnerability

Feel free to contact us via `support@teamamaze.xyz`.

Please CC the maintainers too:
-   `vishalmeham2@gmail.com`
-   `airwave209gt@gmail.com`
-   `emmanuelbendavid@gmail.com`
-   `t.v.s10123@gmail.com`

---