standard-pull-request.md 1.5 KB

Read first

If this is an unsolicited change, or there is no existing issue filed for it, please open a GitHub issue before creating a pull request. This will allow us to discuss the motivations and the big picture behind the change first. It's possible there may be other solutions that should be discussed for what you think should be built. It is possible your change will be rejected unless some discussion around your proposal happens first. While creating this PR means you probably already did the work, it still makes sense to file an issue now, and into the future when you have proposed changes.

Description

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 and start a conversation, even if your PR is not ready for review.

Fixes # (issue)

Screenshot Examples or Logs

If this is a frontend change, please include a screenshot of the change. If this is a backend change, please include relevant logs or examples of the change in action if applicable.


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?

Thank you so much for contributing to Owncast! 🎉