search

dwyl / dwylbot

:robot: Automating our GitHub Workflow to improve team communication/collaboration and reduce tedious repetition!
28 stars 7 forks source link

Generate PR Description based on Commit Messages including links to issues #98

Open nelsonic opened 7 years ago

nelsonic commented 7 years ago

Creating a PR with a blank description will "invite" @dwylbot to generate the PR description for you based on your commit messages and referring to the the issues linked to in those commits.

You (the developers) can then edit the PR Description to add/remove any detail.

This will train people to write better commit messages and link to issues as only the commit messages with some detail and a link will be included while others will be flagged as "insufficient detail in commit message".

SimonLab commented 7 years ago

"Creating a PR without a blank description will "invite" @dwylbot to generate the PR description", should be with? We only want dwylbot to generate a description only if there is no description, right? Or is the idea to complete the user description with a commit description from dwylbot?

nelsonic commented 7 years ago

@SimonLab well-spotted. I was just checking if you were paying attention... 😉 (updated) 👍

iteles commented 7 years ago

I'll be interested to see if this trains people to write better commit/PR messages or if it makes people lazy to not include PR descriptions because they will be auto-generated (might not be a problem but we won't get screenshots for example)

nelsonic commented 7 years ago

@iteles something we'll have to test. but either way we need to streamline our workflow. I prefer having descriptive and detailed commit messages with links to issues in any case. Nobody will use the Pull Request description for "forensic" purposes because PR will not show up in "Git Blame".