Add missing problem info to solutions with no description - no code needed

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Choose a Python file in solutions/python/ that starts with code or has only a title, then read it to identify the problem and approach. Add the requested Problem, Source and Note comments at the top; leave the code unchanged. Done means the file has useful context, and you comment on the issue with the filename you picked.

Written by the indexing model from the issue text.

Description

5-minutes algorithm all-levels any-language beginner-friendly community documentation easy first-timers-only good first issue hacktoberfest help wanted learning no-code-needed open-source python students

You don't have to write code to contribute

Some solutions have no information at all: no problem name, no description, no link. Help the next learner know what they are looking at.

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

Task
  • Pick any file in solutions/python/ that starts with code instead of a comment, or has only a title (tip in PowerShell: Get-ChildItem solutions/python/*.py | Where-Object { (Get-Content $_ -TotalCount 1) -notmatch '^#' })
  • Read the code and work out what problem it solves
  • Add a header at the very top: # Problem: (the name), # Source: (a link, if you can find the same problem online), # Note: (one line about the approach)
  • (Optional) Add the time complexity if you know it

Only edit comments, please don't change the code. If you are not sure what the problem is, say so in your comment instead of guessing.

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.