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

chore: add disclaimer to PR template #1351

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As discussed in the linked issue, there was room for improvement in the communication around PRs and issues at the time of contributing. This PR adds a disclaimer to the PR template that aims at making more explicit to contributors that a PR should be preceded by a triaged issue.

This PR resolves #1350.

How to verify this change

See the bottom of this PR description, where I have manually pasted the same markdown that I have added to the template. The PR template will be in effect starting from the next PR after this one is merged.

Related issues, RFCs

Issue number: #1350

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Feb 28, 2023
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Feb 28, 2023
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Feb 28, 2023
@dreamorosi dreamorosi merged commit d0fab1a into main Feb 28, 2023
@dreamorosi dreamorosi deleted the 1350-maintenance-add-disclaimer-to-pr-template-to-clarify-that-prs-need-to-be-linked-to-a-triaged-issue branch February 28, 2023 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: add disclaimer to PR template to clarify that PRs need to be linked to a triaged issue
1 participant