pull_request_template.md

Description

Describe the problem you're addressing here.

Related JIRA tickets:

• ENSCOMPARASW-XXXX

Overview of changes

Give details of what changes were required to solve the problem. Break into sections if applicable.

Change 1

• detail 1.1

Change 2

• detail 2.1

Testing

How was this tested? Have new unit tests been included?

Notes

Optional extra information.

---

PR review checklist

• Is the PR against an appropriate branch?
• Does the code adhere to coding guidelines?
• Does the code do what it claims to do?
• Is the code readable? Is it appropriately documented?
• Is the logic in the correct place?
• Was the code tested appropriately? Are there unit tests? Are unit tests self-contained and non-redundant?
• Did Travis CI pass for the code in the PR? Is Codecov acceptable based on the included/updated unit tests?
• Will the new code fail gracefully?
• Does the code follow good practice for writing performant code (e.g. using a database transaction rather than repeated queries outside of a transaction)?
• Does it bring in an unnecessary dependency?
• If you are reviewing a new analysis, is it future-proof and pluggable?
• Does the PR meet agile guidelines?