Docs, Comments और Commit Messages

जल्दी मसौदा, सत्य के लिए संपादन

Assistants diff को commit message में, function को docstring में, या नोट्स को README खंड में बदलने में अच्छे हैं। जोखिम ऐसे text का है जो सही लगता है पर ऐसा व्यवहार बताता है जो कोड में नहीं है। हर वाक्य को कोड से मिलाकर पढ़ें। ऐसे comments चुनें जो क्यों समझाएँ, न कि वे जो वही दोहराएँ जो पंक्ति स्पष्ट रूप से करती है।

Commit message की prompt

उसे diff और अपनी शैली दें। Conventional Commits एक आम format है।

git diff --staged | pbcopy     # or xclip / clip on your OS
# Prompt: "Write a Conventional Commits message for this diff.
#          Subject under 72 chars, then a short body explaining WHY."

कोड में "क्यों" दर्ज करें

व्यावसायिक कारण और पिछली घटनाएँ वही हैं जो assistant नहीं जान सकता। अपरिचित निर्णयों के लिए छोटे comments ख़ुद लिखें ताकि भविष्य के पाठकों और भविष्य के assistants के पास संदर्भ हो।

त्वरित जाँच: AI-लिखित documentation का मुख्य जोखिम क्या है?

• वह comments हटा देता है
• वह हमेशा बहुत छोटा होता है
• वह Markdown उपयोग नहीं कर सकता
• वह ऐसा व्यवहार बता सकता है जो कोड में वास्तव में नहीं है