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

Shorten PR template #382

Merged
merged 1 commit into from
Oct 19, 2023
Merged

Shorten PR template #382

merged 1 commit into from
Oct 19, 2023

Conversation

smelc
Copy link
Contributor

@smelc smelc commented Oct 18, 2023

This PR changes the PR template so that it looks like below. The rationale is that right now most developers don't use the PR list of checkboxes, so I have:

  • Removed all checkboxes that are enforced by CI anyway
  • Kept only checkboxes that are good practices reminders
  • I have added a How to trust this PR section In my experience, this section can entice developers to help the reviewers, which is important, because reviews is often a bottleneck we're all blocked on regularly 🙂

New PR template

Changelog

- description: |
    Change PR template
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@smelc smelc added the enhancement New feature or request label Oct 18, 2023
@smelc smelc changed the title Less checkboxes in PR template Shorten PR template Oct 18, 2023
@newhoggy newhoggy added this pull request to the merge queue Oct 19, 2023
Merged via the queue into main with commit 9e8cbcb Oct 19, 2023
22 of 23 checks passed
@newhoggy newhoggy deleted the smelc/shorten-PR-template branch October 19, 2023 06:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants