Describe your PRs

12 views
Skip to first unread message

Stian Thorgersen

unread,
Dec 2, 2021, 3:28:21 AM12/2/21
to Keycloak Dev
I regularly see PRs being sent where neither the JIRA (or GH issue), the PR, or commit message describes anything.

Please take a few minutes to:

* Provide a good summary that is used both in the JIRA summary, as well as the commit
* Provide a clear description in the JIRA (or GH issue soon) that describes from a users perspective what is being improved/added/fixed
* Provide a clear description in the PR description that describes to other developers (and reviewers) how you implemented the issue

This will help a lot when reviewing PRs, when figuring out what's new in a release, as well as can provide a lot of useful context and information down the line, for example if your change introduced a regression.
Reply all
Reply to author
Forward
0 new messages