From 36227b040c81cdd2d17f603f591384b22f894844 Mon Sep 17 00:00:00 2001 From: "jameskinyua590@gmail.com" <20414083+JayKay24@users.noreply.github.com> Date: Wed, 24 Jun 2026 12:56:32 +0300 Subject: [PATCH] feat: add pull request template and update project documentation accordingly Signed-off-by: jameskinyua590@gmail.com <20414083+JayKay24@users.noreply.github.com> --- .github/pull_request_template.md | 10 ++++++++++ README.md | 5 +++-- agents.md | 1 + 3 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8f538ab --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ +### Summary + + +### Key Changes + +- + +### Verification + +- diff --git a/README.md b/README.md index 92262a2..11d261a 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,9 @@ I manage this monorepo using **Pantsbuild (Pants)**, targeting **Python 3.10.x** ```text data-engineering/ ├── .github/ -│ └── workflows/ -│ └── ai-review.yml # CI pipeline for automated AI code reviews +│ ├── workflows/ +│ │ └── ai-review.yml # CI pipeline for automated AI code reviews +│ └── pull_request_template.md # Template for standardizing PR descriptions ├── .gitignore # Python, Pants, and OS ignore rules ├── .pre-commit-config.yaml # Configures the local pre-commit hook ├── .python-version # Sets project-local Python to 3.10.9 diff --git a/agents.md b/agents.md index b4ac7a2..82f5a24 100644 --- a/agents.md +++ b/agents.md @@ -19,6 +19,7 @@ This repository is a **Python Data Engineering Monorepo** managed by the **Pants ### Project Structure * `.github/workflows/ai-review.yml`: Automated Gemini AI PR reviewer workflow on GitHub Actions. +* `.github/pull_request_template.md`: Template for standardizing PR descriptions. * `.pre-commit-config.yaml`: Pre-commit hooks configuration to run `./pants fmt` and `./pants lint` locally. * `3rdparty/`: Contains requirements (`requirements.txt`) and Pants lockfiles (`user_reqs.lock`). * `projects/essentials/`: First sub-project (derived generic implementation from *Hello Modern Data Pipelines*, Chapter 2).