freedomofpress / freedomofpress/securedrop-dev-docs
Add repository structure explanation to developer docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
With an inflation of repos especially related to the SecureDrop Workstation, it can be hard as a new contributor to understand what repositories are relevant to a contribution objective. To help folks untangle the repo structure, we should add at least a simple annotated list, and possibly a more elaborate diagram, to the documentation.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by surveying the repositories related to SecureDrop Workstation and the contribution objectives they support. Document the relevant repositories in an annotated list, adding a diagram if the relationships require more explanation; done means a new contributor can identify where to make a contribution.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100