Add Python type annotation

Open
#263 14 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
Over a week
Newbie friendliness
24/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
python

Research direction

The issue gives only an external example PR (#284) and asks for type annotations across the project, with no target files named. Start by reading the example PR and the public modules in jwcrypto to settle an annotation style and scope. Done means the agreed public API is annotated and the project's static-analysis check passes, but a newcomer should get maintainer agreement on scope first.

Written by the indexing model from the issue text.

Description

enhancement

type annotations autodocument the function parameters and allow for static analysis and other nice things.
See https://github.com/pythongssapi/python-gssapi/pull/284 for an example.

Dominant language
Python
Stars
478
Forks
132
Avg merge
7h 38m
Merged PRs (30d)
4

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from latchset/jwcrypto

All issues in latchset/jwcrypto

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.