Thank you for your interest in contributing to this project. Whether you are a student submitting coursework, an instructor improving materials, or a community member fixing a bug, this guide explains how to participate.
- Student Submission Workflow
- Community Contributions
- Code Style
- Commit Message Conventions
- Pull Request Guidelines
- Review Process
- What Not to Submit
# Fork this repository on GitHub, then clone your fork
git clone https://github.com/<your-username>/GeekInk-Python-Engineering.git
cd GeekInk-Python-EngineeringCreate a branch named after yourself and the module you are working on:
git checkout -b <your-username>/module-01Place your submissions in the following directory structure:
task/students/<your-github-username>/
README.md # Your name, cohort, and learning journal
module-01/
day-001/
solution.py # Your solution for Day 1
notes.md # Optional: your notes and reflections
day-002/
solution.py
...
module-02/
day-011/
solution.py
...
Each day's directory should contain your solution file(s) and any supporting files required by the exercise.
Write clear, descriptive commit messages:
git add task/students/<your-username>/module-01/day-001/
git commit -m "Add Day 001 solution: variables and data types"git push origin <your-username>/module-01Then open a Pull Request on GitHub targeting the main branch.
When opening a pull request, use this format in the description:
## Student Submission
**Name:** [Your Name]
**GitHub:** [Your GitHub Username]
**Module:** [Module Number]
**Days Covered:** [e.g., Day 001 -- Day 010]
## Summary
Brief description of what you completed in this submission.
## Self-Assessment
- [ ] All daily challenges completed
- [ ] Code runs without errors
- [ ] Code follows PEP 8 style guidelines
- [ ] Each solution includes comments where the logic is non-obvious
- [ ] No secrets, credentials, or environment files included
- [ ] No __pycache__ or compiled files includedInstructors, mentors, and community members can contribute by:
- Fixing typos or broken links in lesson materials.
- Improving explanations or adding examples.
- Adding new exercises or challenges.
- Translating materials.
- Reporting issues.
- Fork and clone the repository.
- Create a feature branch:
git checkout -b fix/typo-in-day-005. - Make your changes.
- Ensure any existing tests still pass.
- Commit with a clear message.
- Push and open a Pull Request.
All Python code in this repository should follow PEP 8:
- Use 4 spaces for indentation (no tabs).
- Limit lines to 79 characters for code, 72 for comments and docstrings.
- Use
snake_casefor functions and variables. - Use
PascalCasefor class names. - Use
UPPER_SNAKE_CASEfor constants. - Include a blank line at the end of every file.
- Use meaningful, descriptive names for variables and functions.
Write commit messages in the imperative mood. Keep the subject line under 72 characters. Use the body for additional context when needed.
Format:
<type>: <short description>
<optional body explaining why, not what>
Types:
| Type | When to Use |
|---|---|
add |
Adding new files, features, or exercises |
fix |
Fixing a bug or correcting an error |
update |
Improving or changing existing content |
docs |
Documentation-only changes |
refactor |
Restructuring code without changing behavior |
test |
Adding or updating tests |
Examples:
add: Day 015 solution for dictionary comprehensions
fix: correct variable name typo in Day 003 example
docs: improve explanation of inheritance in Module 04 README
- One PR per module (for student submissions) or per logical change (for contributions).
- Ensure your code runs without errors before submitting.
- Fill in the PR description completely.
- Do not include unrelated changes.
- Respond to review feedback promptly.
- A maintainer or instructor will review your PR within a few days.
- You may receive feedback requesting changes. This is part of the learning process.
- Make the requested changes, commit, and push. The PR updates automatically.
- Once approved, a maintainer will merge your PR.
Students may also participate in peer reviews. Reviewing others' code is an excellent way to learn. Be constructive, specific, and respectful in your feedback.
Do not include any of the following in your submissions:
__pycache__/directories or.pycfiles.envfiles or any credentials, API keys, or secretsvenv/,.venv/, or any virtual environment directories.DS_Store,Thumbs.db, or other OS-generated files- Compiled binaries or build artifacts
- Node modules or other unrelated dependency directories
- Large datasets (use a
.gitignoreor link to external sources)
The repository .gitignore is configured to exclude most of these, but verify your staged files before committing:
git statusIf you have questions about the submission process:
- Check the Student Guide.
- Ask your instructor or mentor.
- Open a GitHub Issue describing your question.
Thank you for contributing to GeekInk Python Engineering.