Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (61 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

91 lines (61 loc) · 2.29 KB

Contributing to Python 101

Thank you for helping improve this course! Contributions of all sizes are welcome.

Ways to Contribute

  • 🐛 Bug report — broken exercise, incorrect code, wrong expected output
  • ✏️ Wording fix — unclear question, typo, misleading comment
  • 💡 Exercise suggestion — a good practice question for a grade
  • 🖥️ OS / version note — something that behaves differently on Windows, macOS, or Linux, or across Python versions
  • 📄 Docs improvement — README, tips, or setup clarifications

Before You Start

  1. Check existing issues — your idea may already be logged.
  2. One change per PR — keeps reviews focused and fast.
  3. Test your code — run any Python you add before submitting.

How to Contribute

1. Fork and Clone

git clone https://github.com/<your-username>/python-101.git
cd python-101

2. Set Up the Environment

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

3. Create a Branch

git checkout -b fix/grade3-list-exercise
git checkout -b feat/grade5-csv-challenge
git checkout -b docs/add-windows-note-grade8

4. Make Your Changes

  • Exercise files live in exercises/grade-X/grade_X.py
  • Sample data lives in resources/
  • CI workflow lives in .github/workflows/ci.yml

5. Commit and Push

git commit -m "fix: correct expected output in grade 3 dict exercise"
git commit -m "feat: add challenge exercise to grade 4 lambdas"
git commit -m "docs: clarify venv activation on Windows in grade 8"

6. Open a Pull Request

Push your branch and open a PR on GitHub. Fill in the PR template.

Exercise Contribution Guidelines

Follow the existing comment style in exercise files:

# Exercise X.Y
# Plain English description of what the student needs to write.
# Tip: (optional) a hint if the concept is likely to trip people up.

# YOUR CODE HERE
  • Questions must be solvable using only concepts taught up to that grade
  • Challenge exercises are welcome — mark them with # (Challenge) in the comment
  • Do not include answers in the exercise files
  • Keep each question focused on one concept

Code of Conduct

Be constructive and kind. This course is for learners at all levels.