[bisq-network/bisq] Added a Pull Request template (#3691)

Florian Reimair notifications at github.com
Wed Nov 27 12:55:54 UTC 2019


### General response

thanks for your suggestions and time spent thinking about that. I, myself, had a much bigger template in the first place and worked it down to just these points. After digging through the [github manual on pull request templates](https://help.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates#pull-request-templates) I realized that a bigger wall of text is going to be less read than just a few lines. The ultimate goal of this is to improve stuff in our workflow and not to teach people how to use github.

Imho, such a template will never be perfect and final. I suggest starting out with this small one and see if it actually has any impact on our workflow. If it does, great, we optimized our workflow. If it does not, there has not been a great waste of resources.

Besides that, I added and tweaked a few lines. We should probably talks about that in the ["Pull Requests" Dev-Call](https://github.com/bisq-network/events/issues/35) if I finally manage to hold that one.

### Onto your comments:

>  It might be good to explain a bit about how GitHub uses the fixes keyword to onboard new users.

As mentioned above, I already had a small wall of text linking to the github manual, explaining, given examples, etc with the same motivation you mention.

But is that really necessary to reach the ultimate goal?
- a template like `Fixes #replaceWithIssueNr` motivates to just fill in the issue number(s) your PR fixes,
- even as experienced devs occasionally miss include the reference, the simple line reminds them in the most unobtrusive way.

The ultimate goal of this line is to close issues which have been resolved and not to teach people how to use github.

> Please also add instructions that the PR title should be communicating the user benefit as good as possible to make it easier to compile release notes.

Again, I thought about including stuff like this. I ultimately decided against it as we already have a [database of do's and don'ts](https://github.com/bisq-network/style/issues) including all sorts of stuff (which, most probably, nobody reads anyways)

> Maybe also add the signing of commits, with a link to the GitHub docu, in the comment block as it is a common problem for new contributors.

Added the link to the CONTRIBUTING.md.



-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/bisq/pull/3691#issuecomment-559076124
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20191127/fd502612/attachment.html>


More information about the bisq-github mailing list