Skip to content

Improve Project Structure and Add Documentation for Python Learning Repository #5

@Ronit049

Description

@Ronit049

This repository contains multiple Python projects and practice problems, but the overall structure and documentation can be improved to make it more beginner-friendly and organized.
Current Issues:

No clear folder structure for different categories (beginner, intermediate, projects)
Missing README files inside individual project folders
Lack of proper project descriptions and usage instructions
No contribution guidelines for others

Suggested Improvements:

Organize folders into:
basics/
projects/
practice/
Add a README.md in each project explaining:
What the project does
How to run it
Example output
Create a main README section listing all projects with links
Add CONTRIBUTING.md for contributors

Benefits:

Makes repository more professional
Easier for beginners to understand and use
Improves chances for collaboration and visibility

Labels: enhancement, documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions