Hacker News Reader

Comment by jldugger | Hacker News Reader

> DEFINITELY say what you are doing. And then say why.

My favored github PR template has 3 sections:

  - What does this PR do?
  - Why is that valuable?
  - Link to bug tracker.

View on HN

We have a similar template at work, and since we made it the default (on Bitbucket you can pre-fill it), it's saved a ton of back and forth asking questions:

* Description: (What this does, and why)

* Ref: (Ticket/task link)

* To test: (Specific instructions to make sure things are working as expected)

* To deploy: (What specific servers/services to restart, and operations to perform)

Reply on news.ycombinator.com