mirror of
https://github.com/narrrl/proton-drive-linux.git
synced 2026-11-04 00:47:00 +01:00
nvrl
9c30ff8276
- scripts/publish-wiki.sh publishes every page listed in SECTIONS, copies images, writes a sectioned sidebar and footer, and removes stale pages. --check fails on links to missing files or headings and on docs pages that are neither published nor excluded. - New wiki.yml runs the check on pull requests and pushes to main, and publishes when release.yml calls it or when started by hand. - Split USER_GUIDE.md into topic pages (files, synced folders, photos, sharing, computers, launcher and tray); add Getting started and FAQ. - Make the COPR repository the main Fedora path, with update and uninstall steps for every package type. - Fix the stale CAPTCHA note in CLI.md, document pdfs unlock and lock, and drop the broken AGENTS.md link from CONTRIBUTING.md.
82 lines
3.8 KiB
Markdown
82 lines
3.8 KiB
Markdown
# Contributing
|
|
|
|
Thanks for taking the time. This is an unofficial Proton Drive client that people trust with real
|
|
files, so the bar for changes that touch the filesystem, the sync engine, or the database is
|
|
deliberately high — everything else is ordinary Rust review.
|
|
|
|
## Before you start
|
|
|
|
- Read [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md) for building, running and debugging from
|
|
source, and [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for how the daemon, front ends, and
|
|
SDK fit together. [`docs/README.md`](docs/README.md) indexes the rest. The same pages are on
|
|
the [wiki](https://github.com/narrrl/proton-drive-linux/wiki).
|
|
- Check [`docs/BUGS.md`](docs/BUGS.md) — it is the authoritative issue ledger, and your problem may
|
|
already be tracked there with context.
|
|
- For anything larger than a fix, open an issue first so the design can be discussed before you
|
|
spend the time.
|
|
|
|
## Development setup
|
|
|
|
```bash
|
|
git clone https://github.com/narrrl/proton-drive-linux.git
|
|
cd proton-drive-linux
|
|
cargo build --workspace
|
|
```
|
|
|
|
GUI and FUSE targets need the GTK4, libadwaita, WebKitGTK 6, libsecret, D-Bus, and FUSE3
|
|
development packages listed in [`docs/INSTALL.md`](docs/INSTALL.md#build-dependencies). Minimum
|
|
supported Rust version is 1.96. [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md#running-from-source)
|
|
explains how to run your build next to, or instead of, the installed service.
|
|
|
|
## Quality gates
|
|
|
|
CI runs exactly these, and they must pass with zero warnings:
|
|
|
|
```bash
|
|
cargo fmt --all -- --check
|
|
cargo clippy --workspace --all-targets -- -D warnings
|
|
cargo test --workspace --locked
|
|
scripts/fuse-acceptance.sh --offline-only
|
|
```
|
|
|
|
Changes to the FUSE layer, sync, or the queue should also pass the simulation runs and be
|
|
exercised against a real mount before review — see [`docs/TESTING.md`](docs/TESTING.md). Live
|
|
runs are destructive: use a dedicated test account, never one holding data you cannot lose.
|
|
|
|
## Making changes
|
|
|
|
- **Keep shared logic in `pdfs-core`.** The CLI and GUI never touch the database or the network;
|
|
they speak the control protocol to the daemon.
|
|
- **The SQLite schema is forward-only.** Never edit a shipped migration — add a new one and bump
|
|
`SCHEMA_VERSION` in `crates/pdfs-core/src/db/migrations.rs`.
|
|
- **Typed errors and `?` over panics** on runtime paths. Blocking filesystem, keyring, or
|
|
control-socket work stays off GTK's main thread.
|
|
- **`staging/` and `recovery/` may hold the only copy of user data.** Nothing may clear or purge
|
|
them opportunistically.
|
|
- **The GUI is fully translated.** Wrap every user-visible string in the helpers from
|
|
`crates/pdfs-gui/src/i18n.rs`, run `po/update.sh`, and translate the new entries in every
|
|
catalog in `po/LINGUAS` in the same change. See [`docs/TRANSLATING.md`](docs/TRANSLATING.md).
|
|
The CLI and daemon messages stay in English.
|
|
- **Document what users see.** A new command, setting or behaviour belongs in the matching page
|
|
under `docs/` (a user guide topic, the CLI reference or configuration) and in the `[Unreleased]`
|
|
section of [`docs/CHANGELOG.md`](docs/CHANGELOG.md). Each release publishes `docs/` to the
|
|
wiki. A new page goes into `SECTIONS` in `scripts/publish-wiki.sh`, and
|
|
`scripts/publish-wiki.sh --check` must pass. CI runs it on every change to `docs/`.
|
|
|
|
## Commits and pull requests
|
|
|
|
Commits follow scoped [Conventional Commits](https://www.conventionalcommits.org), e.g.
|
|
`fix(fuse,core): keep truncate composable with queued revisions`.
|
|
|
|
A pull request should state:
|
|
|
|
- the user-visible effect and which crates it touches,
|
|
- the `docs/BUGS.md` entries it fixes or affects,
|
|
- the commands you ran to verify it,
|
|
- screenshots for GTK changes,
|
|
- and, explicitly, any migration, recovery, data-loss, or packaging implications.
|
|
|
|
## Security
|
|
|
|
Do not open a public issue for a vulnerability — see [SECURITY.md](SECURITY.md).
|