Skip to content

Commit

Permalink
Change github PR template markdown syntax
Browse files Browse the repository at this point in the history 
When doing a PR with [`hub`](https://github.com/github/hub), any
line starting with # will be ignored and not added to the PR message.

Our template uses # for the titles in the markdown syntax, so doing
a PR with `hub` would omit those lines. Using the alternate syntax
with undelying ---- fixes the issue.
  • Loading branch information
@keymon
keymon committed Apr 27, 2018
1 parent 739861c commit ddc70d2
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
## What
What
----

Describe what you have changed and why.

## How to review
How to review
-------------

Describe the steps required to test the changes.

## Who can review
Who can review
--------------

Describe who can review the changes. Or more importantly, list the people
that can't review, because they worked on it.

1 comment on commit ddc70d2

@paroxp
Copy link
Member

@paroxp paroxp commented on ddc70d2 May 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just as we started to introduce that template to other repos...

Please sign in to comment.