TagSpaces is an offline, open source, document manager with tagging support
chore: added clarifications about contributing to the project
Ilian Sapundshiev4ba85cba568e
diff --git a/.glf.jsonc b/.glf.jsoncindex 60c749a4a..ee9c20e46 100644--- a/.glf.jsonc+++ b/.glf.jsonc@@ -1,21 +1,5 @@{- // Default config - can be passed in via config and/or CLI"inputs": ["./package.json", "./release/app/package.json"],"output": "./src/renderer/third-party.txt",-"overwrite": true,- // Paths to any file's whose content will be appended to the end of the generated file.- // "append": ["./additional-content.txt"],-- // Substitute the given packages license with the content in the respective file.- // "replace": {- // "[email protected]": "./bespoke-license.txt",- // "another-replaced-package": "./bespoke-license-2.txt",- // },-- // Exclude any packages from the output.- // "exclude": ["[email protected]"],-- // Omit the version number in the output file- // "omitVersion": false,}diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 000000000..b14883ddc--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,63 @@+# Contributing to TagSpaces++Thanks for your interest in improving TagSpaces! Contributions of all kinds are+welcome — bug fixes, features, tests, docs, and translations.++## Contributor License Agreement (required)++Before your first pull request can be merged, you must review and sign the+**Contributor License Agreement (CLA)**:++➡️ <https://www.tagspaces.org/content/tagspaces-cla-v2.pdf>++### Why the CLA matters++TagSpaces is **dual-licensed**: the open-source core is offered under the+AGPL-3.0 **and** under a separate commercial license (see+[LICENSING.md](LICENSING.md)). For that model to hold, TagSpaces GmbH must be+able to license _all_ of the code — including your contribution — under **both**+sets of terms.++By signing the CLA you grant TagSpaces GmbH the right to distribute your+contribution under both the AGPL and the commercial license, while you retain+copyright to your work. Without a signed CLA we cannot merge a contribution,+because it would break the project's ability to offer the commercial license.++## Development setup++```bash+npm install+npm run dev # run the Electron app in development+npm run test # tests+```++See [CLAUDE.md](CLAUDE.md) and the project documentation for the architecture,+the `tagspaces-common` monorepo, and platform-specific (web / Electron /+Capacitor) notes.++## Pull request guidelines++- Keep changes focused; one logical change per PR.+- Match the surrounding code style; the project is formatted with Prettier, so+ ensure your changes are Prettier-clean before submitting.+- Add or update tests where it makes sense (unit tests and/or Playwright e2e).+- Do not add new source files without the standard license header (AGPL-3.0 for+ core files).+- Reference any related issue in the PR description.++## Reporting bugs and requesting features++- Bugs: <https://github.com/tagspaces/tagspaces/issues>+- Feature requests: <https://tagspaces.discourse.group/c/feature-requests/6>++## Translations++Help translate TagSpaces on Transifex:+<https://explore.transifex.com/tagspaces/tagspaces/>++## License of contributions++Unless covered by other terms in the signed CLA, contributions to the core are+made under the [AGPL-3.0](LICENSE.txt) and, per the CLA, may also be distributed+by TagSpaces GmbH under its commercial license. See [LICENSING.md](LICENSING.md)+for the full licensing model.diff --git a/LICENSING.md b/LICENSING.mdnew file mode 100644index 000000000..ebabd7f31--- /dev/null+++ b/LICENSING.md@@ -0,0 +1,100 @@+# Licensing++This document is the canonical description of how TagSpaces is licensed. It+explains the dual-license model, the boundary between the open-source core and+the proprietary Pro components, and why the packaged applications (which combine+both) may be distributed by TagSpaces GmbH.++## Summary++- The **open-source core** of TagSpaces is licensed under the **GNU Affero+ General Public License, version 3 (AGPL-3.0)** — see [LICENSE.txt](LICENSE.txt).+- TagSpaces GmbH is the **copyright holder** of the core and offers it under a+ **dual license**: AGPL-3.0 **or** a separate **commercial license** for+ vendors, resellers, and anyone who cannot accept the AGPL's obligations.+- The **TagSpaces Pro** components are **proprietary** (not AGPL) and are+ governed by the Pro **End User License Agreement (EULA)**.+- Third-party open-source dependencies keep their own licenses; their full texts+ are bundled and disclosed (see [Third-party software](#third-party-software)).++## Component boundary++| Component | Location | License |+| --- | --- | --- |+| TagSpaces core (app, renderer, main, shared libs) | this repository, except `tagspacespro/` | **AGPL-3.0** (© TagSpaces GmbH) |+| TagSpaces Pro module | `tagspacespro/` → published as `@tagspacespro/tagspacespro` | **Proprietary** — © TagSpaces GmbH, all rights reserved; governed by `tagspacespro/EULA.txt` |+| Third-party dependencies & bundled extensions | `node_modules/`, `@tagspaces/extensions` | Their respective upstream licenses (see below) |++Every source file carries a header identifying its license: AGPL-3.0 for core+files, "all rights reserved" for Pro files. The header is authoritative for the+individual file.++## Dual license (the core)++Because TagSpaces GmbH holds the copyright to the core, it may license that same+code under more than one set of terms:++1. **AGPL-3.0** — for open-source use. You may use, study, modify, and+ redistribute the core under the terms of [LICENSE.txt](LICENSE.txt),+ including the AGPL's source-availability and network-use (§13) obligations.+2. **Commercial license** — for organizations that want to use, embed, or+ redistribute TagSpaces without the AGPL's copyleft obligations. Contact+ TagSpaces GmbH for terms.++Contributions are accepted under a Contributor License Agreement that preserves+this dual-licensing ability — see [Contributions](#contributions).++## Proprietary Pro components++The code under `tagspacespro/` (distributed as `@tagspacespro/tagspacespro`) is+**not** covered by the AGPL. It is proprietary to TagSpaces GmbH, its source is+not published, and end-user rights to it are granted solely under the Pro EULA+(`tagspacespro/EULA.txt`). Pro features are unlocked via license key or in-app+purchase.++## Combined distributions (why the packaged apps are lawful)++The packaged **Lite** builds contain only the AGPL core. The packaged **Pro**+builds (desktop, and mobile where Pro is unlocked via in-app purchase) contain+**both** the AGPL core and the proprietary Pro module in a single binary.++A *third party* combining AGPL-licensed code with proprietary code and+distributing the result would generally have to release the whole combined work+under the AGPL. That restriction does not bind the **copyright holder**:+TagSpaces GmbH owns the core and therefore may combine it with its own+proprietary Pro module and distribute the result, licensing the core under its+commercial terms and the Pro module under the EULA. This is the standard+"open-core / dual-license" model and is the basis on which the Pro builds and+the App Store / Play Store distributions are shipped.++## Source availability (AGPL compliance)++The corresponding source for the AGPL core is this public repository:+<https://github.com/tagspaces/tagspaces>. The application also links to it+in-app (About → Source Code) and displays the applicable license text in-app+(About → License: the AGPL for Lite, the EULA for Pro).++## Third-party software++TagSpaces bundles third-party open-source packages, each under its own license.+The complete, generated list of those packages and their full license texts is+in [`src/renderer/third-party.txt`](src/renderer/third-party.txt) (regenerated+with the `generate-license-file` tool) and is shown in-app under+**About → Software Acknowledgements**. There is no separate notices file; that+generated file is the authoritative third-party disclosure.++## Trademarks++The names "TagSpaces", the TagSpaces logo, and related marks are trademarks of+TagSpaces GmbH. The open-source license covers the **code**, not the marks:+forks and redistributions may use the code under the AGPL but must not use the+TagSpaces name or logo in a way that implies endorsement or that could cause+confusion, except as permitted by applicable trademark law.++## Contributions++Contributions are accepted under the Contributor License Agreement published at+<https://www.tagspaces.org/contribute/>. Signing it grants TagSpaces GmbH the+right to distribute your contribution under **both** the AGPL and the commercial+license, which is what keeps the dual-license model intact. See+[CONTRIBUTING.md](CONTRIBUTING.md) for the contribution workflow.diff --git a/README.md b/README.mdindex 43de467f3..1f2fa0fbc 100644--- a/README.md+++ b/README.md@@ -151,7 +151,7 @@ TagSpaces supports extension modules for opening and editing different file type### 🤝 Contributing-We welcome contributions! Please review and sign the [Contributor License Agreement (CLA)](https://www.tagspaces.org/contribute/) before submitting PRs.+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md), and review and sign the [Contributor License Agreement (CLA)](https://www.tagspaces.org/content/tagspaces-cla-v2.pdf) before submitting PRs.## 🌍 Localization@@ -177,3 +177,5 @@ TagSpaces is not optimized for locations with more than 100,000 files.## 📄 LicenseTagSpaces is dual-licensed under the [AGPL](LICENSE.txt) (GNU Affero General Public License) v3 for open-source projects and a commercial license for vendors or resellers. Contact us if you're interested in using TagSpaces under different terms.++The TagSpaces Pro components (`tagspacespro/`) are proprietary and governed by a separate EULA. For the full picture — the open-source/proprietary boundary, how the combined builds are distributed, and third-party notices — see [LICENSING.md](LICENSING.md).diff --git a/src/renderer/third-party.txt b/src/renderer/third-party.txtindex b9abcb95c..b435031ea 100644--- a/src/renderer/third-party.txt+++ b/src/renderer/third-party.txt@@ -2408,7 +2408,7 @@ MIT LicenseThe following npm package may be included in this product:- - @tagspacespro/[email protected]+ - @tagspacespro/[email protected]This package contains the following license:@@ -6518,6 +6518,7 @@ The following npm packages may be included in this product:- @capacitor/[email protected]- @capacitor/[email protected]- @capacitor/[email protected]+ - @capacitor/[email protected]These packages each contain the following license:@@ -8718,6 +8719,7 @@ The following npm packages may be included in this product:- @react-dnd/[email protected]- @react-dnd/[email protected]- @tokenizer/[email protected]@@ -12402,7 +12404,7 @@ SOFTWARE.The following npm package may be included in this product:- - @tagspaces/[email protected]+ - @tagspaces/[email protected]This package contains the following license: