Thank you for helping improve Cryptomator's documentation!
- Fork the repository
- Clone your fork:
git clone <your-fork-url> - Enable Corepack so the pinned pnpm version is used:
corepack enable - Install dependencies:
pnpm install - Start development server:
pnpm start
- Documentation files are in the
docs/folder - Use clear, concise language
- Include screenshots or examples where helpful
- Test your changes locally before submitting
We follow git flow for contributions:
- Create a feature branch:
git checkout -b feature/improve-docs - Make your changes and commit:
git commit -m "Improve setup instructions" - Push to your fork:
git push origin feature/improve-docs - Open a pull request
Note: Branch names and commit messages above are examples. Use descriptive names that reflect your actual changes.
- Keep content up-to-date with the latest app versions
- Use consistent formatting and style
- Break up long sections with headings and lists
- Link to related documentation when relevant
pnpm-workspace.yaml sets minimumReleaseAge: 4320 (3 days). pnpm
will refuse to resolve any package version younger than that — most
malicious releases are detected and unpublished within hours, so the
delay protects us at near-zero cost.
If you genuinely need a fresh release sooner (e.g. a security fix
just published), add the specific package/version to
minimumReleaseAgeExclude in pnpm-workspace.yaml and call it out
in the PR description.
Routine upgrades land via Dependabot (configured in
.github/dependabot.yml), which opens monthly grouped PRs for npm
dependencies and GitHub Actions. Please don't run pnpm up --latest
on the default branch — review the Dependabot PR instead, or open a
PR with explicit version pins and a changelog link.
Help us keep Cryptomator open and inclusive. Please read and follow our Code of Conduct.
Thank you for taking the time to contribute to the project! 👍
Cryptomator Team