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

feat: Update pull request template #52

Merged
merged 9 commits into from
Jan 22, 2025
Merged

feat: Update pull request template #52

merged 9 commits into from
Jan 22, 2025

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Jan 7, 2025

Proposed changes

This commit fixes the spacing issue of the pull request checklist by
changing the final checklist item. The relevant information now exists
as a sentence after the list, as well as an additional line.

The additional line, alongside a similar one added to the checklist,
direct the reader to our style guide to review specific guidance that
would otherwise be too verbose to add to the template.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the contributing guidelines

  • I have signed the F5 Contributor License Agreement (CLA)

  • If applicable, I have added tests that prove my fix is effective or that my feature works

  • If applicable, I have checked that any relevant tests pass after adding my changes

  • I have updated any relevant documentation (README.md and CHANGELOG.md)

  • I have rebased my branch onto main

  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

  • If the change involves:

    • Code
    • Anything that resembles Personally identifying information (PII)
      • Make sure to use placeholders such as <username> in place of PII
    • URLs (watch for typosquatting)
    • Significant new/revised content

    In these cases, the change will require at least two (2) approvals before merging

This commit fixes the spacing issue of the pull request checklist by
changing the final checklist item. The relevant information now exists
as a sentence after the list, as well as an additional line.

The additional line, alongside a similar one added to the checklist,
direct the reader to our style guide to review specific guidance that
would otherwise be too verbose to add to the template.
This commit fixes the spacing issue of the pull request checklist by
changing the final checklist item. The relevant information now exists
as a sentence after the list, as well as an additional line.

The additional line, alongside a similar one added to the checklist,
direct the reader to our style guide to review specific guidance that
would otherwise be too verbose to add to the template.
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner January 7, 2025 23:04
Copy link

github-actions bot commented Jan 7, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/52/

@ADubhlaoich ADubhlaoich self-assigned this Jan 8, 2025
Copy link
Collaborator

@mjang mjang left a comment

Choose a reason for hiding this comment

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

As noted in #52 (comment)

@ADubhlaoich ADubhlaoich requested a review from a team as a code owner January 15, 2025 16:11
@Jcahilltorre Jcahilltorre requested a review from mjang January 22, 2025 11:36
@Jcahilltorre
Copy link
Contributor

@mjang I suggest to merge this PR with the current improvements and move the conversation about further improvements into a separate conversation/PR

@mjang
Copy link
Collaborator

mjang commented Jan 22, 2025

@mjang I suggest to merge this PR with the current improvements and move the conversation about further improvements into a separate conversation/PR

Given my delayed response, you're absolutely right. #89.

Copy link
Collaborator

@mjang mjang left a comment

Choose a reason for hiding this comment

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

Remaining issues for #89

@mjang mjang merged commit d618e74 into main Jan 22, 2025
5 checks passed
@mjang mjang deleted the update-pr-template branch January 22, 2025 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants