No coding needed: explain a solution in plain English (5 min)

Open Beginner friendly
  • Is something wrong?
#173 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Browse the solution files in the repository and pick one whose top comment is missing or unclear. Read the solution, then improve only its comments to explain in plain English what it does; add time complexity if you can. Comment with the file you chose, and consider the work done when its explanation is clearer without changing code.

Written by the indexing model from the issue text.

Description

5-minutes all-levels beginner-friendly codewars documentation good first issue hackerrank hacktoberfest interview-prep leetcode no-code-needed open-source students

You don't have to write code to contribute

Some solutions have short or missing explanations. Help the next learner understand them.

Time: ~5 minutes | Skills needed: Reading + writing

Task
  • Pick any solution file (any language)
  • Read it
  • Improve the top comment: what does it do, in simple words?
  • (Optional) Add the time complexity if you know it

Only edit comments, please don't change the code.

Explaining code is one of the fastest ways to understand it.

Comment which file you picked.

Open for everyone

This issue is open for everyone: beginners, experienced developers, students, and people who don't code at all. Any language, any level, no experience required. If you want to help, you are welcome here.

How to contribute

  1. Comment on this issue to claim it
  2. Fork this repo
  3. Clone your fork and create a new branch
  4. Make your change
  5. Commit, push, and open a Pull Request

New to open source? Start here before anything else:

First Contributions - github.com/firstcontributions/first-contributions

Prefer video? Watch this: How to contribute on GitHub (YouTube)

If this repo helps you or you like where it is going, a star is a nice way to say thanks and helps other people find it. Entirely optional, and you do not need it to contribute.

Dominant language
Python
Stars
3
Forks
2
Avg merge
3h 48m
Merged PRs (30d)
19

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 Huerte/algo-solutions-python

All issues in Huerte/algo-solutions-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.