freedomofpress / freedomofpress/securedrop-dev-docs
Python type hint examples in contributor guidelines should be updated
Open
Beginner friendly
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
This is a good first issue for new contributors to take on, if you have any questions, please ask on the task or in our Gitter room!
Description
The type hint examples in the contributor guidelines are no longer the style we want, since Python 2 was dropped. They should be updated to use Python 3 type hint syntax.
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 with the contributor guidelines at the linked “Example of type hint” section and locate its documentation source. Update the examples to use Python 3 type hint syntax, then build or review the rendered guidelines to confirm the outdated examples are gone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100