Shahrayar123 / Shahrayar123/Python-Projects

readme files needed

Open
#73 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Hacktoberfest
Dominant language
Python
Stars
582
Forks
441
PR merge metrics
No merged PRs in 30d

Description

Hey, I was just browsing through some of the files and noticed some of the files like "dice-simulator" and "faceRecognition" and the such, didn't have a readme.py as either instructions or how to use code. I would like to help and make those readme files for all those codes missing (appropriate licenses, if necessary).

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by inspecting the dice-simulator and faceRecognition project files, then compare any existing README files for the repository's expected structure. Create README documentation for each project that lacks usage or instruction guidance, and note appropriate licensing needs where relevant.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.