Shahrayar123 / Shahrayar123/Python-Projects

Add consistent folder naming convention for project directories

Open
#318 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description

Project folders and script files in this repository use inconsistent naming formats — some use spaces (Banking App), others underscores (snake_game), and others are all caps (SNAKE).
This inconsistency makes navigation harder and lowers the repository’s overall readability.

Steps to Reproduce
  1. Browse the root directory of the repository.
  2. Compare folder names like Banking App, SNAKE, and WeatherApp.
  3. Notice the different naming styles (spaces, underscores, uppercase, etc.).
Expected Behavior

All project directories and files should follow a single, consistent naming convention, such as:

  • all lowercase
  • words separated by underscores (banking_app, snake_game)
Actual Behavior

Names are inconsistent; some use spaces or uppercase, causing confusion and irregular sorting.

Suggestion
  • Decide one convention (e.g., lowercase_with_underscores).
  • Rename existing folders accordingly.
  • Add a short note in the README or CONTRIBUTING.md describing the convention.
Environment
  • Repository branch: main
  • Observed: 13th November, 2025

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 inventorying the root directories and script files, including examples such as Banking App, SNAKE, and WeatherApp. Review README.md and CONTRIBUTING.md to see where the naming rule should be documented, then define the final convention before renaming items and checking for references that still use the old names.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.