Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (61 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 2.33 KB

🛠️ Contributing to Python Learning Repository

Thank you for your interest in contributing!
This repository is designed to help learners understand Python concepts step by step through well-structured folders, examples, and practice exercises.
Whether you’re fixing typos, improving explanations, or adding new scripts — every contribution is valuable! 💡

🧩 How to Contribute

  1. Fork this repository to your GitHub account.

  2. Clone your fork to your local machine:

    git clone https://github.com/your-username/Python-code.git

  3. Create a new branch for your contribution:

    git checkout -b feature-name

  4. Make your changes (add new files, fix code, or improve documentation).

  5. Commit your updates with a clear message:

    git add .
git commit -m "Added new example for exception handling"

  6. Push the branch to your fork:

    git push origin feature-name

  7. Create a Pull Request (PR) from your branch to the main repository.

🧠 Guidelines

  • Keep the folder and file structure consistent with existing topics. Example:

    ├── 08_Exceptions_Debugging/
│   ├── 01_try_except.py
│   ├── Practice_Exercises/
│   └── README.md

  • Name files numerically and descriptively (e.g., 02_date_time_module.py).

  • Add comments or docstrings to explain code purpose and logic.

  • Include a README.md file when introducing a new topic or section.

  • Avoid adding unnecessary third-party libraries unless relevant to the lesson.

🧾 Code Style

Follow these conventions:

  • Use snake_case for variable and function names.
  • Use 4 spaces for indentation.
  • Keep code clean, readable, and properly formatted.
  • Add blank lines between logical sections of code.
  • Use meaningful commit messages.

💬 Getting Help

If you’re unsure how to contribute, or want to suggest a new idea:

  • Open a Discussion on GitHub.
  • Create an Issue describing your suggestion or problem.
  • Tag maintainers politely for guidance.

🤝 Our Commitment

We aim to maintain a friendly, inclusive learning space. By contributing, you agree to uphold respectful communication and collaborative learning.

Happy coding! 🚀 — Maintained by Sehrish Javed