freedomofpress / freedomofpress/securedrop-dev-docs
Add developer documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
To make issues like https://github.com/freedomofpress/securedrop-sdk/issues/16 easier for developers, we should add some documentation of exactly what format is expected for the requests and responses (one can figure out from the examples / code but worth writing out explicitly). For example, these docs should describe the valid fields for a request (path_query, body, headers, method). This can go in the regular SecureDrop developer documentation, and be linked to in the README in this repository.
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 locating the regular SecureDrop developer documentation and the README in this repository, then review the examples and code that show request and response formats. Document the expected request and response fields, including path_query, body, headers, and method, and link the new documentation from the README.
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
- 42/100