CONTRIBUTING Copy Section

There are various ways to contribute to the project.

USER EXPERIENCE

Bug reports and features requests can be filed in the Issue Tracker or to the developer, see https://peazip.github.io/peazip-more.html

Please note that a quick search in the Issue Tracker database can prevent the creation of duplicate requests, and even provide solutions or workarounds.

TRANSLATIONS

PeaZip is localized in over 30 languages thanking the effort of the community in providing and maintaining the translations

Information about translation is available in PeaZip's Translation repository https://github.com/peazip/PeaZip-Translations and on https://peazip.github.io/peazip-translations.html page.

Translations can be sent to the developer (https://peazip.github.io/peazip-more.html for contact details) or directly committed to main PeaZip's repository https://github.com/peazip/PeaZip/tree/sources/peazip-sources/res/share (translations are in the "lang" subdirectory)

THEMES

PeaZip can be thoroughly customized in terms of icons, colors, and look&feel of the file/archive manager.

Themes page https://peazip.github.io/peazip-themes.html provides all information to start customizing the application either for personal use or for submitting themes to the community (some examples of user provided theme packages are linked in Themes page).

CODE CONTRIBUTIONS

PeaZip is mainly developed in FreePascal using the Lazarus IDE https://www.lazarus-ide.org/

If you are familiar with Pascal language family, or if you are studying one of the many Pascal dialects, you may find interesting to work on sources starting from https://peazip.github.io/peazip-sources.html page, in order to improve the program either for your own use or for sharing it with the community, either as a fork of the project or as a code contribution to the project itself.

If you are not familiar nor interested in Pascal, there are other ways to contribute code to the project, especially in the system integration side, in example: creating Windows context menu entries (currently static methods are employed), creating Linux/BSD .desktop files and generally improving integration on the various DE, creating macOS services menus with Automator.

PORTING AND PACKAGE BUILDING

PeaZip aims to be a cross-platform application, and is currently available for BSD, Linux (compiled for various widget-sets and for aarch64 and x86_64 architectures), macOS (both aarch64 and Intel architectures), and Windows/ReactOS.

Lazarus/FPC can target many more combinations of architectures, Operating Systems, and widget-sets, and any help is welcome in order to port PeaZip on them.

Also, it is very welcome any help for improving existing packages (Portable, DEB, RPM, DMG, Windows installers), and for creating and/or maintaining new packages, like distribution-specific Linux installers working in accordance with repository maintainers - Debian DEB repository and Ubuntu Snap repository are two prominent examples.

---

README Copy Section

<div class="centered" align="center">

PeaZip Free Archiver

| GitHub | GitHub Latest | SourceForge | Flathub |
|:--------------:|:--------------:|:--------------:|:--------------:|
| | | | |

</div>

PeaZip is a free archive manager utility for BSD, Linux, macOS, and Windows, which offers a cross-platform Open Source alternative to proprietary software (WinZip, WinRar, etc.), also available as portable package not requiring installation.

Works with 200+ archive types and variants (7z, ace, arc, brotli, bz2, cab, gz, iso, pea, rar, tar, wim, zip, zipx, zpaq, zstandard...), handles spanned archives (001, r01, z01...).

Can convert existing archives, split/join files, edit comments, search in archives, add files to separate archives.

Supports multiple archive encryption standards, provides file hashing tools, and can export GUI tasks as CLI scripts.

PeaZip also provides a capable file manager: bookmarking, search, instant content filter, duplicate files detection, integrated text, hex, and image viewers.

Features Copy Chapter

Build Instructions Copy Chapter

Useful Links Copy Chapter

---

SECURITY Copy Section

Security

Supported Versions Copy Chapter

Security updates are implemented in the latest release of the software.

The corrective action for a vulnerability is consequently to update the software to the latest release, or to a release reported as safe by the vulnerability's CVE report or by PeaZip's change log https://peazip.github.io/changelog.html

Backporting a fix to an older X.Y.Z version is possible by working on the sourcecode of the target version, which is available as peazip-X.Y.Z.src.zip package on https://github.com/peazip/PeaZip/releases/

Detailed instructions for compiling the application's binaries, and assembling a working package, are available at https://peazip.github.io/peazip-sources.html

Reporting Security Issues Copy Chapter

Vulnerabilities should be reported to developer's email, to allow time for a thorough analisys and implementation of corrective actions before public disclosure, to minimize risks for users.

Please read https://peazip.github.io/peazip-more.html for the developer's email address, link to CVE databases containing previously disclosed vulnerabilities, and link to the Issue Tracker - which, for historical reasons, is hosted on SourceForge.

To help understanding the reported vulnerability please provide:
* Step-by-step instructions to reproduce the issue
* Version(s) tested for the issue, e.g. "Windows Portable package X.Y.Z version"
* Any special configuration required to reproduce the issue (if applicable)
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue

Thank you in advance for helping PeaZip project to grow and to keep providing a safe experience for users.

Preferred Languages Copy Chapter

The preferred language for all communications is English.

---