Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (30 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

37 lines (30 loc) · 2.16 KB
Raw

CONTRIBUTING.md

First off, thank you for considering a contribution to The Python Ledger! High-quality, accessible education is built by the many, not the few.

As a contributor, you are a "Ledger Keeper". Whether you're fixing a typo or designing a new module, your help keeps this roadmap accurate for the next generation of developers.

🏗️ Our Architecture

To keep things simple, we use a Two-Repo System:

  • The Ledger (This Repo): Contains only Markdown files.
  • The Engine: A separate repository that handles the website and the Python interpreter.

You do not need to know React or JavaScript to contribute here. You only need to know Markdown and Python.

🛠️ How to Contribute

  • Fix a Typo or Bug If you see a mistake in a lesson:

    1. Click the "Edit this page" button at the bottom of the lesson on the website.
    2. This will take you directly to the file on GitHub.
    3. Make your changes and submit a Pull Request (PR).

  • Propose a New Lesson or Project If you want to add a new section to the curriculum:

    1. Open Curriculum Roadmap to see what lessons need to be worked on.
    2. Open an Issue first to discuss the scope.
    3. Fork this repository.
    4. Create a new .md file in the appropriate folder (e.g., 01-foundations/).
    5. Follow the Lesson Guidelines document to structure your lesson to confront with the project lessons.
    6. Submit a draft PR for so we can label the lesson as Being Worked On as soon as you have some content. Our pipeline will check your document for inconsistencies automaticly even in draft PRs.

🚦 Pull Request Process

  • Submit a draft PR as soon as possible so somebody else does not do double work.
  • Ensure your Markdown is valid and links are not broken.
  • When your changes are complete, submit a PR.
  • Your PR will be reviewed by a maintainer.
  • Once merged, the Engine will automatically detect the changes and rebuild the live site within minutes.

📜 Code of Conduct

By contributing, you agree to uphold our Code of Conduct. We are dedicated to providing a harassment-free experience for everyone, regardless of skill level or background.