Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add section about user impact to PR template #8003

Merged
merged 4 commits into from
Nov 16, 2021
Merged

Add section about user impact to PR template #8003

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e01b882
Add section about user impact to PR template
sherifnada Nov 16, 2021
66ad745
Update .github/pull_request_template.md
sherifnada Nov 16, 2021
659f981
Update pull_request_template.md
sherifnada Nov 16, 2021
06a3c39
Update .github/pull_request_template.md
sherifnada Nov 16, 2021
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
6 changes: 5 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,16 @@
1. `x.java`
2. `y.python`

## 🚨 User Impact 🚨
Are there any breaking changes? If yes, please make sure to include it here and in any changelogs with the 🚨🚨 emoji
What is the end result perceived by the user?
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's probably more useful to put this in the connector README than in PR description? People usually won't check this.

Copy link
Contributor Author

@sherifnada sherifnada Nov 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

the goal of this is to get the developer to think about the end impact this particular PR they are raising will have on the user especially if it contains a breaking change. If there is a breaking change, then we want to make sure it is:

  1. very thoroughly considered
  2. is communicated to users clearly perhaps via something like #8004

this way, if there are any breaking issues or action required from the user, or just anything they really need to be aware of, this section will bring that to the forefront.

as such, it feels like a README is the wrong place for this, as it is meant as a device to alert the developer that they need to think about the user

Copy link
Contributor

Choose a reason for hiding this comment

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

Got it. Make sense.

I was actually thinking about the connector doc, but I wrote down "README" by mistake. It is probably also worth adding alert about breaking changes to the CHANGELOG section of the connector doc.


## Pre-merge Checklist
Expand the relevant checklist and delete the others.

<details><summary> <strong> New Connector </strong></summary>
<p>
sherifnada marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, sorry that I did not mean to delete this whole line. Just wanted to remove the newly-introduced spaces.


#### Community member or Airbyter

- [ ] **Community member?** Grant edit access to maintainers ([instructions](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork#enabling-repository-maintainer-permissions-on-existing-pull-requests))
Expand Down