Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Started work on issue and PR templates #374

Merged
merged 9 commits into from
Apr 10, 2018
7 changes: 7 additions & 0 deletions docs/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#### What does this PR do?
Copy link
Collaborator

Choose a reason for hiding this comment

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

This seems like standardising existing practice so is definitely good.


#### Where should the reviewer start?
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd tag this as [optional].

Copy link
Member

Choose a reason for hiding this comment

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

Agreed.


#### Ideas that were considered and discarded
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd tag this as [optional].

Copy link
Member

Choose a reason for hiding this comment

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

Maybe

#### Rationale / Background / Ideas considered and rejected [optional]

And perhaps a

#### Possible future work [optional]

Which would allow PR submitters to suggest follow-on work, which we could raise tickets for after appropriate discussion.


#### Relevant tickets
Copy link
Collaborator

@jbcoe jbcoe Apr 8, 2018

Choose a reason for hiding this comment

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

Definitely needed. I often forget this bit.

Probably worth adding

#### Closes [TicketNumbers]

too

Copy link
Member

Choose a reason for hiding this comment

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

Definitely add the closes [ticketnumbers] part! I forget that too often.