freedomofpress / freedomofpress/securedrop-dev-docs

document Rust prerequisites

Open
#156 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
6
Forks
4
Avg merge
2h 22m
Merged PRs (30d)
1

Description

Describe the change

After freedomofpress/securedrop-client#1718, a full Rust toolchain is a prerequisite for running the SecureDrop Client via its ./run.sh, even if you don't intend to do any work on securedrop-proxy.

How will this impact users?

Developers working on the SecureDrop Client MUST have a full Rust toolchain installed.

User Research Evidence

https://github.com/freedomofpress/securedrop-client/pull/1718#issuecomment-2101698767

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the SecureDrop Client developer setup documentation and the ./run.sh entry point, using securedrop-client#1718 for context. Update the documented prerequisites to state that a full Rust toolchain is required even without securedrop-proxy work, then verify the setup instructions reflect that requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.