Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (42 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 2.79 KB

Contributing

Make sure you have read the FAQ

Thank you for wanting to contribute to making QtPass awesome.

Pull Request Process

  1. Sign your commits - All commits must be signed with GPG using git commit -S -m "description".
  2. Ensure install or build dependencies and artifacts are not committed.
  3. When adding big new features or changes to the build tool, update the README.md to reflect those.
  4. Make sure you update all the CI configs if needed. These run on every Pull Request.
  5. Increase the version numbers in relevant files when applicable. The versioning scheme we use is PrideVer.
  6. You may merge the Pull Request once you have the sign-off of one other developer, or if you do not have permission to do that, you may request a reviewer to merge it for you.

Translations

QtPass uses Weblate for translations.

To add a new language:

  • Add your language code to src/src.pro under TRANSLATIONS
  • If you have an existing build, run make distclean first (prevents stale generated files like ui_*.h from being included)
  • Determine which qmake command your Qt 6 installation provides: run qmake6 -v (or qmake -v if qmake6 is unavailable) and confirm it shows Qt version 6.2 or newer.
  • Run that same command (qmake6 or qmake) to prepare the build files.
  • Run lupdate src/src.pro to generate/update the translation .ts files
  • Edit the .ts file with Qt Linguist: linguist localization/qtpass_xx_YY.ts

Qt Linguist has helpful in-context translation options.

Windows Developers: Symlink Setup

This repository contains a symlink (.claude -> .opencode). Windows developers need to enable symlink support:

Option 1: Enable Developer Mode on Windows 10+ (recommended)

  • Go to Settings > Update & Security > For developers
  • Enable "Developer Mode"

Option 2: Configure Git to use symlinks

git config core.symlinks true

Set this before cloning the repository.

Warning: Without symlink support enabled, .claude will be checked out as a regular text file containing the path ".opencode" instead of a proper symlink.

Troubleshooting: After cloning:

  • Run ls -l .claude (Git Bash) or dir .claude (CMD) to verify it shows as a symlink, not a regular file.
  • If it appears as a regular file, set core.symlinks=true in your Git config, then re-checkout the file or re-clone the repository to restore the proper symlink.

Getting Help

License

QtPass is released under the GNU GPL v3.0 license. https://www.gnu.org/licenses/gpl-3.0.html