Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (69 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

99 lines (69 loc) · 2.53 KB

Contributing to Python Mini Projects

Thank you for considering contributing! 🎉
This repository is focused on strengthening Python fundamentals through well-structured mini projects. Contributions are welcome if they align with the learning philosophy of this repository.

📌 Contribution Guidelines

Before contributing, please ensure that:

  • The project follows clean and readable code practices.
  • The logic is beginner-to-intermediate friendly.
  • The code is modular and properly structured.
  • Meaningful variable names are used.
  • Comments are included where necessary.
  • No unnecessary external libraries are introduced unless justified.

This repository prioritizes clarity over complexity.

🚀 Ways to Contribute

You can contribute by:

  • Adding new beginner-to-intermediate mini projects
  • Improving existing project structure
  • Refactoring code for better readability
  • Fixing bugs
  • Improving documentation
  • Adding unit tests
  • Suggesting enhancements via Issues

🛠 How to Contribute

  1. Fork the repository
  2. Clone your fork (git clone https://github.com/your-username/python-mini-projects.git)
  3. Create a new branch (git checkout -b feature/project-name)
  4. Make your changes
  5. Commit your changes (git commit -m "Add: Short meaningful description")
  6. Push to your branch (git push origin feature/project-name)
  7. Open a Pull Request

📂Project Structure Expectations

Each new project should:

  • Be placed inside its own folder
  • Include a clear and runnable main .py file
  • Include a short README explaining: - What the project does - Concepts used - How to run it
  • Have accurate numbering (please check the current numbering)

🧪Code Standards

  • Python 3.10+
  • Follow PEP 8 style guidelines
  • Avoid deeply nested logic where possible
  • Use functions instead of long procedural blocks
  • Handle basic errors gracefully

❗What Not to Submit

  • Extremely advanced projects unrelated to fundamentals
  • Framework-heavy projects
  • AI-generated code without understanding
  • Copy-pasted projects without modification
  • Unreadable or unstructured code

💡Suggestion Process

If you're unsure whether an idea fits, open an Issue first and describe:

  • The project idea
  • The Python concepts involved
  • Why it fits the repository goals Discussion before development is encouraged.

📜Code of Conduct

Be respectful and constructive in discussions.

This repository is intended as a learning-focused environment.

Thank you for helping improve this project 🚀