Skip to content

chore: add checkboxes to PR template#11536

Closed
Goodnight77 wants to merge 2 commits into
deepset-ai:mainfrom
Goodnight77:chore/pr-template-checkboxes
Closed

chore: add checkboxes to PR template#11536
Goodnight77 wants to merge 2 commits into
deepset-ai:mainfrom
Goodnight77:chore/pr-template-checkboxes

Conversation

@Goodnight77

Copy link
Copy Markdown
Contributor

Proposed Changes:

just small update to the pull request template checklist to use markdown checkboxes instead of bullet points

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@Goodnight77 Goodnight77 requested review from a team as code owners June 5, 2026 13:37
@Goodnight77 Goodnight77 requested review from julian-risch and removed request for a team June 5, 2026 13:37
@vercel

vercel Bot commented Jun 5, 2026

Copy link
Copy Markdown

@Goodnight77 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@julian-risch

Copy link
Copy Markdown
Member

@Goodnight77 Thank you for opening this PR and making this suggestion! Unfortunately, in our experience using checkboxes instead of bullet points in the PR description template doesn't work well. We had checkboxes in the past but they are not used in a consistent way and are thus not reliable. For example, sometimes users open PRs and do not tick the boxes while they actually fulfill the expectations. Other times users tick the boxes although they do not fulfill the expectations. For that reason, we choose to keep the bullet point list as a reminder for everyone who opens a PR.

@Goodnight77 Goodnight77 deleted the chore/pr-template-checkboxes branch June 8, 2026 10:48
@Goodnight77

Copy link
Copy Markdown
Contributor Author

@julian-risch Thanks for the explanation and for sharing the context, that totally makes sense. appreciate you taking the time to review the suggestion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants