Add comments and type hints to python code
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Refactor
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- developer-experience
Research direction
No files, tests, or entry points are identified in the issue. Begin by locating the Python code in the repository and determining its scope; done means the relevant Python code has useful comments and type hints that make its behavior easier for contributors to understand.
Written by the indexing model from the issue text.
Description
The python code current has nearly zero comments, which makes it difficult for people to figure out what the code is actually doing. Having comments would make it easier for people who are less familar with python and this specific codebase to contribute. Type hints would also be a useful addition for similar reasons.
- Dominant language
- HTML
- Stars
- 2
- Forks
- 30
- Avg merge
- 15h 56m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
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.
More from ComputerScienceHouse/profiles
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ComputerScienceHouse/profiles#263 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
ComputerScienceHouse/profiles#264 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
ComputerScienceHouse/profiles#192 · 2 comments ·
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
ComputerScienceHouse/profiles#188 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 30/100
ComputerScienceHouse/profiles#124 ·
All issues in ComputerScienceHouse/profiles
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
palladius/rails8-app-on-gcp#145 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/gradle-plugins#156 ·
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
dotenvx/dotenv-vscode#139 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Fission-AI/OpenSpec#1960 ·