Skip to content

feat: add pull request template and update project documentation acco… #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JayKay24 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add pull request template and update project documentation acco… #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
### Summary
<!-- Provide a clear explanation of why these changes were made and the problem they solve. -->

### Key Changes
<!-- Provide a bulleted list of modified modules/files and what was updated. -->
-

### Verification
<!-- Document successful test/run commands executed during verification (e.g. ./pants lint ::). -->
-
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down