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.

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

Update contributor's checklists in PR template #2659

Merged
merged 4 commits into from
Jun 21, 2022
Merged

Update contributor's checklists in PR template #2659

merged 4 commits into from
Jun 21, 2022

Conversation

ZanSara
Copy link
Contributor

@ZanSara ZanSara commented Jun 13, 2022

Problem:

  • In external PRs, contributor's seems to often be confused about which checkboxes to tick. In some cases they ignore the list, in others they go ahead and check boxes that we assume were dedicated to reviewers. This makes the checklist itself less effective.

Solution:

  • I believe splitting the checklist into Contributor's and Reviewer's can bring more clarity and ease the reviewer's job.
  • Some checkboxes seemed outdated and therefore removed (the first draft vs final code: now PRs can be marked as Draft, by the reviewers as well if necessary)
  • Some checkboxes were added for the reviewers (the labels review)

Contributor's Checklist:

Reviewer's Checklist:

  • Review labels
  • Documentation PR (if relevant): (copy here link to PR from the documentation repo)

@ZanSara ZanSara added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Jun 13, 2022
@ZanSara ZanSara requested a review from masci June 13, 2022 15:02
Copy link
Contributor

@masci masci left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of this!

In the spirit of this PR, I'd go all-in with making the PR template contributor-centric by removing any instruction for the reviewer (in any case, the item about documentation PRs will become obsolete very soon, which leaves the checklist with just one item).

About the contributor part, I'd rephrase it in a way that the recipient of the checklist is obvious, something like:

Pre-flight checklist

  • I have read the contributors guidelines
  • I have enabled actions on my fork
  • If this is a code change, I have added tests and docstrings
  • If this is a substantial change, the PR description contains a link to the relevant issue(s)

WDYT?

@ZanSara
Copy link
Contributor Author

ZanSara commented Jun 15, 2022

I have slightly modified your template to keep tests and docstrings separate, and I moved the issues in the top to make it more prominent. It now looks like:


Related Issue(s): ...

Proposed changes:

  • ...

Pre-flight checklist

@ZanSara ZanSara requested a review from masci June 15, 2022 08:10
@ZanSara ZanSara changed the title Split contributor's and reviewer's checklists in PR template Update contributor's checklists in PR template Jun 15, 2022
@ZanSara ZanSara marked this pull request as ready for review June 21, 2022 07:28
Copy link
Contributor

@masci masci left a comment

Choose a reason for hiding this comment

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

🚢

@ZanSara ZanSara merged commit a6c06ee into master Jun 21, 2022
@ZanSara ZanSara deleted the PR-template branch June 21, 2022 08:11
Krak91 pushed a commit to Krak91/haystack that referenced this pull request Jul 26, 2022
* Split contributor's and reviewer's checklists

* contributor-centric checklist

* Move issues at the top and split entry

* phrasing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-for-release-notes PRs with this flag won't be included in the release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants