mirrors/Sandboxie
mirrors
/
Sandboxie
mirror of https://github.com/sandboxie-plus/Sandboxie.git
1
0
Fork 0
Code Releases Activity

Add contribution guidelines

This commit is contained in:
isaak654 2022-09-27 18:06:50 +02:00
parent a323d54ba3
commit 29fcc36e23
No known key found for this signature in database
GPG Key ID: 59D402040437EC44
2 changed files with 78 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,49 @@
# Contributing to the Sandboxie project
- [Monetary contributions](#monetary-contributions)
- [Non-monetary contributions](#non-monetary-contributions)
- [How to help with Sandboxie issues?](#how-to-help-with-sandboxie-issues)
## Monetary contributions
1. Get a [supporter certificate](https://sandboxie-plus.com/go.php?to=sbie-get-cert) <br>
A supporter certificate is like a license key and enables the use of new supporter exclusive features, like [Privacy Mode](https://sandboxie-plus.com/privacy-mode/) or [Application Compartment](https://sandboxie-plus.com/app-box/) sandboxes. See the [Feature Comparison table](https://sandboxie-plus.com/feature-comparison/) for more details and certificate options. <br>
In order to use Sandboxie Plus in specific business or education contexts, a [Business certificate](https://xanasoft.com/product/sandboxie-plus-business-certificate/) is required!
2. Get a [Patreon subscription](https://www.patreon.com/DavidXanatos) <br>
Patreon certificates are valid for as long as the subscription is active and unlock all features. Patreons which ended their subscription are entitled to a residual certificate corresponding to the total amount of their support. See also [how to renew a Patreon supporter certificate](https://github.com/sandboxie-plus/Sandboxie/issues/2144).
3. Donate with [PayPal](https://sandboxie-plus.com/go.php?to=donate)
4. Donate with cryptocurrencies <br>
In order to arrange custom payments with cryptocurrencies, please get in touch by [email](https://xanasoft.com/contact/).
## Non-monetary contributions
Contributor certificates do not expire and are available to all people who open meaningful [pull requests](https://docs.github.com/articles/creating-a-pull-request) or provide continued support to the [Sandboxie-docs](https://github.com/sandboxie-plus/sandboxie-docs) / [Sandboxie](https://github.com/sandboxie-plus/Sandboxie) repositories.
For example:
1. You could add a new Sandboxie Plus translation for the language of your country, see also [Localization notes and tips](https://github.com/sandboxie-plus/Sandboxie/discussions/1123#discussioncomment-1203489).
2. You could help to keep updated our [Sandboxie-docs repository](https://github.com/sandboxie-plus/sandboxie-docs) by providing a number of meaningful changes. More volunteers are needed to keep it constantly updated with the new introduced settings mentioned in the [CHANGELOG.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/CHANGELOG.md) file.
3. You could provide new code changes that fix a specific Sandboxie functionality or introducing a new one.
4. You could offer your availability to become a [collaborator](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository#collaborator-access-for-a-repository-owned-by-a-personal-account) in the [Sandboxie-docs](https://github.com/sandboxie-plus/sandboxie-docs) / [Sandboxie](https://github.com/sandboxie-plus/Sandboxie) repositories (after proving your continued support with open issues and/or sufficient skills to manage pull requests).
If you are a new contributor or collaborator, please get in touch by [email](https://xanasoft.com/contact/).
## How to help with Sandboxie issues?
We encourage the developers and community to conduct research, report issues, and suggest improvements on this code base.
However, please do not report security vulnerabilities in public GitHub comments. This repository has a [SECURITY.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/SECURITY.md) file with instructions on responsibly reporting security vulnerabilities.
You may also want to follow the following topics:
- [The least strict sandboxing rules](https://github.com/sandboxie-plus/Sandboxie/issues/1515#issuecomment-1006408988)
- [The use of the Sandboxie Trace log features](https://github.com/sandboxie-plus/Sandboxie/issues/1208#issuecomment-1200170825)
- [The use of Procmon traces to track file and registry access](https://github.com/sandboxie-plus/Sandboxie/issues/1679#issuecomment-1065760921)
- [Reporting issues to third-party vendors in case of evident conflicts](https://github.com/sandboxie-plus/Sandboxie/issues/2025#issuecomment-1200110235)
- Check out the issues under the [Documentation](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3Adocumentation) label (even the closed ones)
- Check out the discussions under the [Documentation and notes](https://github.com/sandboxie-plus/Sandboxie/discussions/categories/documentation-and-notes) category
- Check out the notes in the [README.md](https://github.com/sandboxie-plus/Sandboxie#readme) file
- Check out the new introduced features in the [CHANGELOG.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/CHANGELOG.md) file <br> (a good way to highlight them is a simple search of the `=` sign in your browser)
- Check out whether the problem has already been reported in the [old Sandboxie forum](https://www.ecosia.org/search?method=index&q=site%3Ahttps%3A%2F%2Fsandboxie-website-archive.github.io%2Fwww.sandboxie.com%2Fold-forums%2F) or in the [Issues](https://github.com/sandboxie-plus/Sandboxie/issues) section

57
README.md
View File

@ -1,19 +1,19 @@
# Sandboxie
[![GitHub Release](https://img.shields.io/github/release/sandboxie-plus/Sandboxie.svg)](https://github.com/sandboxie-plus/Sandboxie/releases/latest) [![GitHub Pre-Release](https://img.shields.io/github/release/sandboxie-plus/Sandboxie/all.svg?label=pre-release)](https://github.com/sandboxie-plus/Sandboxie/releases) [![GitHub Build Status](https://github.com/sandboxie-plus/Sandboxie/actions/workflows/main.yml/badge.svg)](https://github.com/sandboxie-plus/Sandboxie/actions)
# Sandboxie Plus / Classic
<img align="left" src="https://user-images.githubusercontent.com/12372772/123517080-8ab20a00-d69f-11eb-8e82-2e18cf6e0303.png">
Sandboxie is a sandbox-based isolation software for 32-bit and 64-bit Windows NT-based operating systems. It creates a sandbox-like isolated operating environment in which applications can be run or installed without permanently modifying local & mapped drives or the windows registry. An isolated virtual environment allows controlled testing of untrusted programs and web surfing.<br><br>
[![Plus license](https://img.shields.io/badge/Plus%20license-Custom%20-blue.svg)](https://github.com/sandboxie-plus/Sandboxie/blob/master/Installer/license.txt) [![Classic license](https://img.shields.io/github/license/Sandboxie-Plus/Sandboxie?label=Classic%20license&color=blue)](https://github.com/sandboxie-plus/Sandboxie/blob/master/LICENSE) [![GitHub Release](https://img.shields.io/github/release/sandboxie-plus/Sandboxie.svg)](https://github.com/sandboxie-plus/Sandboxie/releases/latest) [![GitHub Build Status](https://github.com/sandboxie-plus/Sandboxie/actions/workflows/main.yml/badge.svg)](https://github.com/sandboxie-plus/Sandboxie/actions) [![GitHub Codespell Status](https://github.com/sandboxie-plus/Sandboxie/actions/workflows/codespell.yml/badge.svg)](https://github.com/sandboxie-plus/Sandboxie/actions/workflows/codespell.yml)
| System requirements | Release notes | Security policy |
| :---: | :---: | :---: |
| Windows 7 or higher, 32-bit or 64-bit. | [CHANGELOG.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/CHANGELOG.md) | [SECURITY.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/SECURITY.md) |
Sandboxie is a sandbox-based isolation software for 32-bit and 64-bit Windows NT-based operating systems. It creates a sandbox-like isolated operating environment in which applications can be run or installed without permanently modifying local & mapped drives or the Windows registry. An isolated virtual environment allows controlled testing of untrusted programs and web surfing.<br>
We encourage the developers and security community to conduct research, report issues, and suggest improvements on this code base. However, please do **not** report security vulnerabilities in public GitHub comments. This repository has a SECURITY file with instructions on responsibly reporting security vulnerabilities.
| System requirements | Release notes | Security policy | Project maintenance | Contribution guidelines |
| :---: | :---: | :---: | :---: | :---: |
| Windows 7 or higher, 32-bit or 64-bit. | [CHANGELOG.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/CHANGELOG.md) | [SECURITY.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/SECURITY.md) | David Xanatos ([Roadmap](https://github.com/sandboxie-plus/Sandboxie#project-maintenance)) | [CONTRIBUTING.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/CONTRIBUTING.md) |
## ⏬ Download
## Download
[![GitHub All Releases](https://img.shields.io/github/downloads/sandboxie-plus/Sandboxie/total?style=for-the-badge)](https://github.com/sandboxie-plus/Sandboxie/releases/latest)
## Features
## 🚀 Features
Sandboxie is available in two flavors, Plus and Classic. They both share the same core components, this means they have the same level of security and compatibility.
What's different is the availability of features in the user interface.
@ -31,25 +31,25 @@ Classic build has the old no longer developed MFC based UI, hence it lacks nativ
If you need to check all new features at once, a good way to highlight them quickly is to find the equal sign in the [CHANGELOG.md](https://github.com/sandboxie-plus/Sandboxie/blob/master/CHANGELOG.md) file.
## Documentation
## 📚 Documentation
A GitHub copy of the [Sandboxie documentation](https://sandboxie-plus.github.io/sandboxie-docs) is currently maintained, although more volunteers are needed to keep it updated with the new changes. We recommend to check also the following labels in this repository:
[future development](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3A"future+development") | [documentation](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3Adocumentation) | [build issues](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3A%22build+issue%22) | [known issues](https://github.com/sandboxie-plus/Sandboxie/labels/Known%20issue) | [regressions](https://github.com/sandboxie-plus/Sandboxie/issues?q=is%3Aissue+is%3Aopen+label%3Aregression) | [workaround](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3Aworkaround) | [help wanted](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3A%22help+wanted%22) | [more...](https://github.com/sandboxie-plus/Sandboxie/labels?sort=count-desc)
[future development](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3A"future+development") | [feature requests](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3A"Feature+request") | [documentation](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3Adocumentation) | [build issues](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3A%22build+issue%22) | [known issues](https://github.com/sandboxie-plus/Sandboxie/labels/Known%20issue) | [regressions](https://github.com/sandboxie-plus/Sandboxie/issues?q=is%3Aissue+is%3Aopen+label%3Aregression) | [workaround](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3Aworkaround) | [help wanted](https://github.com/sandboxie-plus/Sandboxie/issues?q=label%3A%22help+wanted%22) | [more...](https://github.com/sandboxie-plus/Sandboxie/labels?sort=count-desc)
A partial archive of the [old Sandboxie forum](https://sandboxie-website-archive.github.io/www.sandboxie.com/old-forums) that was previously maintained by Invincea is still available. If you need to find something there, please use the corresponding [repository search](https://github.com/Sandboxie-Website-Archive/sandboxie-website-archive.github.io).
A partial archive of the [old Sandboxie forum](https://sandboxie-website-archive.github.io/www.sandboxie.com/old-forums) that was previously maintained by Invincea is still available. If you need to find something specific, it is possible to use the following [search query](https://www.ecosia.org/search?method=index&q=site%3Ahttps%3A%2F%2Fsandboxie-website-archive.github.io%2Fwww.sandboxie.com%2Fold-forums%2F).
## Project maintenance
2004 - 2013 Ronen Tzur
## 📌 Project maintenance
2013 - 2017 Invincea Inc.
| Project history | Maintainer |
|---------------------|------------------|
| 2004 - 2013 | Ronen Tzur |
| 2013 - 2017 | Invincea Inc. |
| 2017 - 2020 | Sophos Group plc |
| [Open Source release](https://github.com/sandboxie/sandboxie) | Tom Brown |
| 2020 onwards | David Xanatos ([Roadmap](https://www.wilderssecurity.com/threads/sandboxie-roadmap.445545/)) |
2017 - 2020 Sophos Group plc
Open Source release
2020 onwards David Xanatos
## Project support / sponsorship
## 📌 Project support / sponsorship
[<img align="left" height="64" width="64" src="https://raw.githubusercontent.com/sandboxie-plus/Sandboxie/master/.github/images/binja-love.png">](https://binary.ninja/)
Thank you [Vector 35](https://vector35.com/) for providing a [Binary Ninja](https://binary.ninja/) license to help with reverse engineering.
@ -61,7 +61,8 @@ Binary Ninja is a multi-platform interactive disassembler, decompiler, and binar
<br>
<br>
## Helpful Contributors
## 📑 Helpful Contributors
- DavidBerdik - Maintainer of [Sandboxie Website Archive](https://github.com/Sandboxie-Website-Archive/sandboxie-website-archive.github.io)
- diversenok - Security analysis & PoC's
- stephtr - CI / Certification
@ -85,7 +86,8 @@ Binary Ninja is a multi-platform interactive disassembler, decompiler, and binar
- blap - Maintainer of [SandboxToys2](https://github.com/blap/SandboxToys2)
- okrc - Code fixes
## Translators
## 🌏 Translators
- yuhao2348732, nkh0472, yfdyh000, gexgd0419, Zerorigin, UnnamedOrange, 4rt3mi5 - Simplified Chinese
- TragicLifeHu, Hulen - Traditional Chinese
- RockyTDR - Dutch
@ -103,7 +105,6 @@ Binary Ninja is a multi-platform interactive disassembler, decompiler, and binar
More volunteers are welcome here! ;)
## Support the project
If you like the tool, please consider supporting it on Patreon: https://www.patreon.com/DavidXanatos
## 🤝 Support the project
Or you can donate directly via the PayPal button on my website: https://xanasoft.com
If you find Sandboxie useful, then feel free to contribute through our [Contribution guidelines](https://github.com/sandboxie-plus/Sandboxie/blob/master/CONTRIBUTING.md).