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

Updating PR template #7480

Merged
merged 6 commits into from
Jul 2, 2024
Merged

Updating PR template #7480

merged 6 commits into from
Jul 2, 2024

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Jun 6, 2024

Pull Request/Issue Resolution

Description of Change:

Updating our current PR template for the Braze Docs repository. Feel free to add comments and suggestions. My goal is to cut down the noise on the PR templates to increase the readability and usability for internal and external contributors. Open to any/all feedback!

Is this change associated with a Braze feature/product release?

  • Yes (Insert Feature Release Date Here)
  • No

✔️ Pull Request Checklist
  • Check that you haven't removed any images (replacing an image with an updated one of the same name is fine), as this breaks the French site
  • Check that all links work.
  • Ensure you have completed our Contributors License Agreement.
  • Tag @josh-mccrowell-braze and @internetisaiah as a reviewer when your work is done and ready to be reviewed for merge. Are you an internal product manager? Reference the internal reviewing chart to tag the appropriate reviewer.
  • If the documentation involves a 1) paid SKU, 2) a third party, 3) SMS, 4) AI, or 5) privacy, ensure that Ana Teresa Serafino on the Legal team has signed off.
  • Tag others as reviewers as necessary.
  • If you have modified any links, be sure to add redirects to assets > js > broken_redirect_list.js
⭐ Helpful Wiki Shortcuts
❗ ATTN: For PR Reviewers
  • Read our Reviewing a PR page for more on our reviewing suggestions.
  • Read our Previewing Documentation page to see how to check the deployment.
    • Preview all changes in the linked Vercel environment by clicking the preview link in the vercel-bot comment in your PR.
❗ ATTN: Internal Reviewing Chart
Work at Braze and not sure who to tag for review?
Before tagging @josh-mccrowell-braze or @internetisaiah for a general review, reference the following chart to see if a specific product vertical/reviewer applies to your pull request.

Reviewer Product Vertical
@josh-mccrowell-braze Monolith Deployments
Quality Infrastructure
Platform Infrastructure
Datalake
SDKs
Currents
@internetisaiah Developer Guide
Technology partners
Channels
@bre-fitzgerald Intelligence
In-App Messages
Channels
Frontend Infrastructure & Experience (FIX)
@lydia-xie Ingestion
Core Objects
Core Messaging
Messaging Experience
Message Components
Email (Composition and Infrastructure) (tag @rachel-feinberg for Liquid use cases)
@rachel-feinberg Customer Lifecycle, Identity and Permissions
SMS
User Targeting
Reporting

@internetisaiah internetisaiah self-assigned this Jun 6, 2024
@cla-bot cla-bot bot added the cla-signed label Jun 6, 2024
@internetisaiah internetisaiah marked this pull request as ready for review June 6, 2024 18:43
@internetisaiah internetisaiah added the status: do not merge Could mean research before "in progress" status, or do not merge yet. label Jun 6, 2024
Adding a note about a commonly-viewed issue
@internetisaiah internetisaiah removed the status: do not merge Could mean research before "in progress" status, or do not merge yet. label Jul 2, 2024
@internetisaiah internetisaiah requested a review from a team July 2, 2024 17:19
Copy link
Contributor

@lydia-xie lydia-xie left a comment

Choose a reason for hiding this comment

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

looks great! left 2 small suggestions 🫡

.github/PULL_REQUEST_TEMPLATE Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE Outdated Show resolved Hide resolved
Co-authored-by: Lydia Xie <87040416+lydia-xie@users.noreply.github.com>
Copy link
Contributor

@rachel-feinberg rachel-feinberg left a comment

Choose a reason for hiding this comment

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

Lgtm! Left a small comment

Copy link
Collaborator

@bre-fitzgerald bre-fitzgerald left a comment

Choose a reason for hiding this comment

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

Looks great! Love this change 😍 Left one suggestion for a bit of clarification, otherwise LGTM

.github/PULL_REQUEST_TEMPLATE Outdated Show resolved Hide resolved
Co-authored-by: Bre Fitzgerald <82903296+bre-fitzgerald@users.noreply.github.com>
@internetisaiah internetisaiah merged commit 8cb51eb into develop Jul 2, 2024
3 checks passed
@internetisaiah internetisaiah deleted the update-pr-template branch July 2, 2024 21:03
@lydia-xie lydia-xie mentioned this pull request Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants