Skip to content

Commit 348c875

Browse files
authored
docs: PR self-review checklist (#645) (#687)
Signed-off-by: Rishabh Ranjan Singh <rishabhrsingh19@gmail.com>
1 parent 3b13adc commit 348c875

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
2626

2727
- fix: Replaced `collections.namedtuple` with `typing.NamedTuple` in `client.py` for improved type checking.
2828
- chore: Refactored examples/custom_fee.py into three separate example files.
29+
- Expanded `docs/sdk_developers/checklist.md` with a self-review guide for all pull request submission requirements (#645).
30+
2931

3032

3133
### Fixed

docs/sdk_developers/checklist.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Pull Request Checklist
1+
# Developer PR Submission Checklist
22

3-
Before submitting your PR, verify:
3+
## Table of Contents
4+
- [Prior to Submission](#1-prior-to-submission)
5+
- [Post-Submission Verification](#2-post-submission-verification)
6+
7+
---
8+
9+
## 1. Prior to Submission
410

511
## Required ✅
612

@@ -16,13 +22,36 @@ Before submitting your PR, verify:
1622
- [ ] Verified GitHub shows commits as "Verified"
1723

1824
## Don't Do This ❌
25+
Once you have opened your Pull Request (PR), you must double-check the automated workflow results **BEFORE** requesting a formal review.
1926

2027
- [ ] Work on the `main` branch
2128
- [ ] Mix multiple issues in one PR
2229
- [ ] Skip changelog updates
2330
- [ ] Force push without `--force-with-lease`
2431
- [ ] Include sensitive information
2532

33+
## 2. Post-Submission Verification
34+
35+
Once you have opened your Pull Request (PR), you must double-check the automated workflow results **BEFORE** requesting a formal review.
36+
37+
### How to Verify All Requirements on GitHub
38+
39+
Navigate to your PR page on GitHub and use the **Checks** and **Commits** tabs to verify the following:
40+
41+
| Requirement | GitHub Location | Status to Look For | Action if Failed |
42+
| :--- | :--- | :--- | :--- |
43+
| **Commit Signature** | **Commits Tab** | Must show **"Verified"** (Green badge) | See **[Signing Guide](signing.md)** for how to set up GPG and fix unverified commits. |
44+
| **DCO Check** | **Checks Tab** | The "DCO" or "License" check must show a **Green Checkmark**. | See **[Signing Guide](signing.md)** to ensure your commits have the DCO sign-off (`-s`). |
45+
| **Tests Pass (CI)** | **Checks Tab** (Workflows like 'Integration Tests') | All required tests must show a **Green Checkmark**. | View the logs for the failing check to debug the error locally. |
46+
| **Changelog Formatting** | **Checks Tab** ('PR Formatting / Changelog Check') | Must show a **Green Checkmark**. | Correct the `CHANGELOG.md` and force push. See **[Changelog Guide](changelog_entry.md)**. |
47+
48+
### The Files Changed Tab
49+
50+
The **Files Changed Tab** shows the exact **difference** between your branch and the `main` branch. This is the key document maintainers use for review.
51+
**Your Goal:** Submitted PRs should have a diff that achieves the issue and meets all items in the pre-submit checklist.
52+
53+
---
54+
2655
## Need Help?
2756

2857
- **Signing issues?**[Signing Guide](signing.md)

0 commit comments

Comments
 (0)