הודעת קומיט ותיאור PR שמסבירים למה

הודעת קומיט שכתוב בה "תיקון באג" לא עוזרת לאף אחד, ובעיקר לא לכם בעוד חצי שנה. ה-diff כבר מראה מה השתנה, ולכן ההודעה צריכה להסביר למה. הפרומפט הזה בונה הודעה שמתחילה מהבעיה, ותיאור PR שאומר לסוקר איפה להסתכל. הפרומפט כתוב באנגלית ומוכן להעתקה, מתוך ספריית הפרומפטים של כליקס. מה שבסוגריים מרובעים הוא מה שאתם ממלאים לפני ההדבקה. כל מודל חזק. עדיף כלי שרואה את ה-diff בעצמו.

קוד ומפתחים · git · commit · PR · תיעוד

Write a commit message and a pull request description for this change.

The diff:
[paste it, or point at the branch]

Why I made this change:
[the actual reason, including anything that is not visible in the diff]

Commit message rules:
- First line: what changed, imperative, under 72 characters, no ticket prefix.
- Blank line.
- Body: why this change was needed. Start from the problem, not from the solution. The diff already shows what changed, so do not restate it line by line.
- If the change fixes a bug, describe how the bug actually manifested to a user.
- If a non-obvious approach was chosen, say what the alternative was and why it was rejected.
- Plain prose. No bullet list of file names.

Pull request description rules:
- One paragraph of context for someone who has not seen this code.
- What a reviewer should look at most carefully, and why.
- How it was verified: what was tested and what was not.
- Any known limitation or follow-up left deliberately undone.

Do not invent test results, benchmarks, or verification I did not tell you about. If I did not say how it was tested, write that testing is still needed.

איך להשתמש בזה נכון