owncast/.github/PULL_REQUEST_TEMPLATE/standard-pull-request.md
2023-07-23 10:15:04 -07:00

1 KiB

Please include a summary of the change and which issue number is fixed, including relevant motivation and context. Feel free to mark this as a Draft or WIP and write up some details later.

If there is no issue filed for this particular change it's highly recommended you file one. While creating this PR means you probably already did the work, in the future make sure an issue is filed beforehand so changes, fixes and features can be discussed ahead of time.

Description

Fixes # (issue)


Some things you might want to mention:

  1. Why are you making the change?
  2. Explain how it works and decisions you made.
  3. If you're fixing something, what was wrong? How should we stop from having this issue happen again?
  4. If this is a new feature or addition to functionality, why should it be added? What are the use cases? Who was asking for this functionality?

If this is an unsolicited change or have no issue associated please do your best to detail the motivations behind this PR, and think about filing an issue to discuss changes ahead of time in the future.