mohitagw15856/pm-claude-skills / i18n/hi/skills/pr-description-writer
pr-description-writer
Verifiedgit diff, ब्रांच सारांश या कमिट सूची से एक स्पष्ट, संरचित पुल रिक्वेस्ट विवरण लिखें। जब कोई PR विवरण लिखने, पुल रिक्वेस्ट का मसौदा बनाने या कोड बदलाव दस्तावेज़ित करने को कहे, तब इसका उपयोग करें। सारांश, प्रेरणा, किए गए बदलाव, परीक्षण चरण और समीक्षक मार्गदर्शन के साथ विवरण तैयार करता है।
PR विवरण लेखक स्किल
diff, कमिट सूची या अनौपचारिक नोट से संरचित, समीक्षक-अनुकूल पुल रिक्वेस्ट विवरण लिखता है। क्या, क्यों और कैसे-समीक्षा-करें को कवर करता है ताकि समीक्षक तुरंत शुरू कर सकें।
बिल्कुल यही नहीं चाहिए? जब आप चाहें कि यह GitHub कनेक्टर से वास्तविक diff पढ़े, तो
pr-description-liveका उपयोग करें।
आवश्यक इनपुट
न दिए गए हों तो ये माँगें:
- क्या बदला (git diff,
git log --onelineपेस्ट करें, या बदलावों को सादी भाषा में बताएँ) - क्यों बदला (हल की जा रही समस्या या जोड़ा जा रहा फ़ीचर)
- इसे कैसे टेस्ट करें (समीक्षक को यह काम करता है यह सत्यापित करने के लिए कोई विशिष्ट चरण)
- जोखिम स्तर (निम्न / मध्यम / उच्च — तय करता है कितना समीक्षक मार्गदर्शन शामिल करना है)
- PR प्रकार (फ़ीचर / बग फ़िक्स / रीफ़ैक्टर / डिपेंडेंसी अपग्रेड / कॉन्फ़िग बदलाव / हॉटफ़िक्स)
- लक्षित ब्रांच (जैसे main / develop / release/2.4 — जोखिम के ढाँचे और समीक्षक मार्गदर्शन पर असर डालता है)
- जुड़ा इश्यू या टिकट (जैसे JIRA-1234, GitHub #567 — या "कोई नहीं")
आउटपुट फ़ॉर्मैट
शीर्षक
72 अक्षरों से कम का स्पष्ट, आदेशात्मक शीर्षक:
[type]: [क्या बदला इसका संक्षिप्त विवरण]
उदाहरण:
feat: add rate limiting to the public APIfix: resolve race condition in session expiryrefactor: extract payment logic into PaymentService
सारांश
2–3 वाक्य जो कवर करें:
- यह PR क्या करता है (बदलाव)
- इसकी ज़रूरत क्यों थी (समस्या या लक्ष्य)
- अपनाया गया तरीका (उच्च स्तर पर)
किए गए बदलाव
विशिष्ट बदलावों की बुलेट सूची — प्रति तार्किक बदलाव एक बुलेट, प्रति फ़ाइल नहीं:
- [Y] सँभालने के लिए [X] जोड़ा
- [B] घटाने के लिए [A] रीफ़ैक्टर किया
- [C] हटाया क्योंकि इसकी जगह [D] आया
- [F] ठीक करने के लिए [E] अपडेट किया
स्क्रीनशॉट / डेमो
[UI बदलाव हो तो: पहले/बाद के स्क्रीनशॉट या स्क्रीन रिकॉर्डिंग शामिल करें] [API बदलाव हो तो: उदाहरण रिक्वेस्ट/रिस्पॉन्स शामिल करें] [कोई दृश्य बदलाव और कोई API कॉन्ट्रैक्ट बदलाव न हो तो: यह खंड पूरी तरह छोड़ दें — प्लेसहोल्डर के रूप में न छोड़ें]
कैसे टेस्ट करें
चरण-दर-चरण निर्देश जिनका समीक्षक पालन कर सके:
- [ज़रूरत हो तो सेटअप चरण]
- [करने योग्य क्रिया]
- [क्या सत्यापित करें]
- [जाँचने योग्य किनारे का मामला]
ज़रूरी कोई विशिष्ट कमांड, टेस्ट डेटा या एनवायरनमेंट फ़्लैग शामिल करें।
परीक्षण चेकलिस्ट
- यूनिट टेस्ट जोड़े/अपडेट किए
- इंटीग्रेशन टेस्ट जोड़े/अपडेट किए
- किनारे के मामले कवर किए
- मैनुअल टेस्टिंग पूरी
- मौजूदा टेस्ट में कोई रिग्रेशन नहीं
समीक्षक नोट
अतिरिक्त ध्यान माँगने वाली कोई भी चीज़ चिह्नित करें:
- अनिश्चितता के क्षेत्र जहाँ दूसरी राय स्वागत योग्य है
- जानबूझकर किए गए समझौते (और क्यों)
- देखे गए पर संबोधित न किए गए दायरे से बाहर के आइटम
- दूसरे PR पर निर्भरताएँ (उन्हें लिंक करें)
संबंधित
- Closes #[इश्यू नंबर] (लागू हो तो)
- Related to #[PR/इश्यू नंबर]
गहरी सामग्री
यह स्किल सहायक फ़ाइलों के साथ आती है — उपलब्ध हों तो उनका उपयोग करें:
references/reviewer-empathy.md— समीक्षा नेविगेशन के रूप में PR विवरण। आउटपुट बनाते समय इसे लागू करें; इसमें वह कैलिब्रेशन और निर्णय-विवेक है जिसे ऊपर का संक्षिप्त तरीका संकुचित कर देता है।templates/pr-template.md— डिलिवरेबल का भरने योग्य संस्करण, गुणवत्ता-जाँच इनलाइन सहित। जब उपयोगकर्ता दस्तावेज़ खुद बनाना चाहे, उसे जनरेट करवाने के बजाय, तब यह पेश करें।
स्कोरिंग रूब्रिक (0–40)
इस स्किल का कोई भी आउटपुट सौंपने से पहले स्कोर करें; 32+ शिप-गुणवत्ता है।
| आयाम | 0 | 5 | 10 |
|---|---|---|---|
| क्या के ऊपर क्यों | विवरण सिर्फ़ diff दोहराता है; कोई प्रेरणा नहीं | क्या स्पष्ट है, पर क्यों कमज़ोर या सामान्य ("कोड सुधारता है") | समस्या, लक्ष्य और तरीका स्पष्ट; विवरण वह संदर्भ जोड़ता है जो diff नहीं दे सकता |
| शीर्षक और संरचना | एक असंरचित अनुच्छेद; शीर्षक धुँधला, बिना प्रकार उपसर्ग, या 72 अक्षरों से ज़्यादा | हेडर के साथ संरचित, पर शीर्षक या खंड उपयोग में चूक (प्लेसहोल्डर खंड छोड़े गए) | मान्य प्रकार उपसर्ग, आदेशात्मक रूप, 72 अक्षरों से कम; खंड समीक्षक को सीधे ज़रूरी हिस्से तक ले जाते हैं |
| परीक्षण की पुनरुत्पादकता | कोई परीक्षण चरण नहीं | चरण हैं पर कोडबेस से परिचय मानते हैं या किनारे के मामले छोड़ते हैं | कोड से अपरिचित कोई भी सत्यापन दोहरा सके — कमांड, टेस्ट डेटा, फ़्लैग और कम से कम एक किनारे का मामला शामिल |
| जोखिम-कैलिब्रेटेड समीक्षक मार्गदर्शन | उच्च-जोखिम PR बिना समीक्षक नोट, या विशुद्ध टेम्पलेट नोट | नोट हैं पर कोई विशिष्ट समझौता, अनिश्चितता या दायरे से बाहर का आइटम नहीं बताते | मार्गदर्शन जोखिम से मेल खाता है: उच्च-जोखिम विशिष्ट चिंताएँ और जानबूझकर किए समझौते बताता है; निम्न-जोखिम नोट को एक पंक्ति रखता या छोड़ देता है |
गुणवत्ता जाँच
- शीर्षक आदेशात्मक रूप में और 72 अक्षरों से कम है
- सारांश क्या और क्यों दोनों समझाता है (सिर्फ़ क्या नहीं)
- बदलावों की सूची तार्किक बदलाव बताती है (फ़ाइल-दर-फ़ाइल नहीं)
- शीर्षक मान्य प्रकार उपसर्ग (feat / fix / refactor / chore / deps / config / hotfix) से शुरू होता है और 72 अक्षरों से कम है
- परीक्षण चरण कोड से अपरिचित व्यक्ति द्वारा दोहराए जा सकते हैं
- उच्च-जोखिम PR के लिए समीक्षक नोट कम से कम एक विशिष्ट चिंता या जानबूझकर किया समझौता बताते हैं; निम्न-जोखिम PR के लिए समीक्षक नोट या तो छोड़े गए हैं या एक पंक्ति के हैं
एंटी-पैटर्न
- ऐसा विवरण न लिखें जो सिर्फ़ क्या बदला दोहराए — समझाएँ कि बदलाव क्यों किया गया
- परीक्षण चरण न छोड़ें — समीक्षकों को जानना है कि बदलाव काम करता है यह कैसे सत्यापित करें
- उच्च-जोखिम PR के समीक्षक नोट न छोड़ें — जानबूझकर किए समझौते और सावधान समीक्षा वाले क्षेत्र चिह्नित करें
- diff से स्पष्ट कार्यान्वयन विवरण न बताएँ — वह संदर्भ जोड़ें जो diff नहीं दे सकता
- एक अनुच्छेद न दें — हेडर से संरचित करें ताकि समीक्षक ज़रूरी हिस्से तक पहुँच सकें
उपयोग के उदाहरण
- "इन बदलावों के लिए PR विवरण लिखो" + [diff या विवरण पेस्ट करें]
- "[फ़ीचर] के लिए पुल रिक्वेस्ट का मसौदा बनाओ"
- "मुझे PR विवरण चाहिए — मैंने यह बदला है"
- "इन कमिट को PR विवरण में संक्षेपित करो"
- "इस ब्रांच के लिए PR बॉडी लिखो"
इस स्किल को अपने ब्राउज़र में चलाएँ: https://mohitagw15856.github.io/pm-claude-skills/skill/pr-description-writer.html
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementation | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirements | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |