Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (33 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.47 KB
Raw

Contributing to Python Under The Hood

First of all, thank you for your interest in contributing!

Python Under The Hood is an open-source educational project that aims to teach Python from beginner fundamentals to advanced concepts while gradually exploring what happens behind the scenes in CPython.

Ways to Contribute

You can contribute by:

  • Fixing typos or grammatical mistakes
  • Improving explanations
  • Adding examples
  • Adding practice questions
  • Improving formatting and readability
  • Reporting bugs or incorrect information
  • Suggesting new chapter topics

Before Contributing

Please:

  1. Check existing issues before opening a new one.
  2. Keep explanations beginner friendly.
  3. Ensure examples are accurate and tested.
  4. Maintain a clear and educational writing style.

Pull Requests

When submitting a pull request:

  • Clearly describe the changes you made.
  • Keep commits focused on a single improvement when possible.
  • Make sure all code examples work correctly.
  • Be respectful and constructive during discussions.

Content Philosophy

This project aims to:

  • Teach Python concepts clearly.
  • Explain not only how code works, but why it works.
  • Gradually introduce CPython internals and implementation details.
  • Remain accessible to beginners while providing deeper insights for curious learners.

Questions?

Feel free to open an issue or start a discussion if you have questions, ideas, or suggestions.

Thank you for helping improve Python Under The Hood!