Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (61 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 2.53 KB

🤝 Contributing to Python Deep Dive

First off, thank you for considering contributing to Python Deep Dive! 🙌
Your support and involvement helps make this project better for everyone. Whether it's fixing bugs, improving documentation, or adding new content — we welcome all contributions.

📋 Table of Contents

💡 How to Contribute

  1. Fork the repository
  2. Create a new branch for your changes:
   git checkout -b feature/my-new-topic

  1. Make your changes locally

  2. Commit your changes with a meaningful message:

   git commit -m "Add explanation for list comprehensions"
  1. Push your changes:
   git push origin feature/my-new-topic
  1. Open a Pull Request (PR) Go to the GitHub page of your forked repo and click on Compare & Pull Request.

🧩 Types of Contributions

Here are some ideas on how you can help:

  • ✍️ Fix typos or improve grammar in content
  • 📘 Add examples or diagrams
  • 🧠 Write explanations for concepts
  • 🧪 Add practice problems or solutions
  • 🚀 Add new topics (e.g., decorators, generators, metaclasses)
  • 🧰 Suggest or build beginner-friendly Python projects
  • 🐞 Fix bugs in code examples or notebooks

🌱 Branching Strategy

Follow this convention when naming your branches:

Type Naming Convention Example
Feature feature/topic-name feature/add-oop-summary
Bugfix fix/short-description fix/typo-in-list-section
Documentation docs/topic docs/update-readme

✅ Pull Request Guidelines

  • Write clear titles and descriptions
  • Reference related issues if applicable: e.g., Fixes #12 or Related to #7
  • Ensure your code is properly formatted
  • Avoid adding large files or unrelated code

🧹 Code Style Guidelines

  • Use snake_case for variables and functions
  • Add inline comments if code isn’t self-explanatory
  • Keep explanations simple and beginner-friendly
  • Prefer clarity over cleverness