Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.33 KB

pull_request_template.md

File metadata and controls

39 lines (24 loc) · 1.33 KB

Description

JIRA ticket

[HIVE-####] <- Replace the pound signs with your JIRA ticket number to have github create a link.

Summary

A summary of the pull request (PR) and the issue it resolves. Please include the following:

  • A link to the relevant issue and/or ClubHouse card
  • A code "walk-through" in bullet points
  • A demo, e.g., screenshots, GIFs, code examples, etc. (OPTIONAL)

Checklists

Basic

  • Did you write tests for the code in this PR?
  • Did you document your changes in the README and/or in docstrings (as needed)?

Security

  • Authorization has been implemented across these changes
  • Injection has been prevented (parameterized queries, no eval or system calls)
  • Any web UI is escaping output (to prevent XSS)
  • Sensitive data has been identified and is being protected properly

Frontend

Notes for the Reviewer

A precise explanation of what the PR reviewer needs to evaluate. This might be:

  • a low-level code review of certain functions
  • a high-level assessment of strategy or architecture
  • a confirmation that the code behaves as expected on another machine