Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## 馃専 Purpose

<!--
Required. Must be written by a human, as short sentences or bullets.
-> Why are you making this change? Start with the problem or request, e.g. "The frontend fails on X because Y."
-> Then say in a few sentences what the PR does.
-> Link a doc or discussion the reader needs for context, don't include link to PRs which PR is stacked on, and don't add links to this linear issue (if multiple linear issues are done as part of this PR, include them all in a comma-separated list in the PR title).
-> For a UI change, add a screenshot or recording here, and the steps to see it working.
-> Do not reveal internal client or security-specific motivations in the description.
-->

## 馃攳 Changes

<!--
Required unless the purpose already says everything that changed, delete this section otherwise.
-> What should a reviewer know before opening the diff?
-> Pick the most important changes that matter, say why anything surprising changed, and for a big PR, where to start.
-> don't list every file or function you changed
-> This section should help the reviewer to understand changes that won't be self-evident from reading down the diff, either because they span multiple files, are complex, or would seem unconnected to the primary goal.
-> Do not reveal internal client or security-specific changes.
-->

## 鈿狅笍 Known issues

<!--
Required if something is broken, unfinished or breaking, e.g. it's behind a feature flag or the fix comes next. Delete this section otherwise.
-> Do not reveal internal client or security-specific issues.
-->

## 馃毇 Blocked by

<!--
Describe anything that must be done before the PR is merged, for example further testing, deployment of something, etc. Delete this section otherwise.
-> Never include dependencies that are already obvious in GitHub (stacked branches).
-->

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did like the "how to test this"/"Demo" section. Can we add it and make it commented out by default perhaps?

The Linear issue talks about this potentially replacing the other templates in the main repo, is that something you expect?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you raise this in this slack thread? We have the context there already.

Loading