diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 00000000000..574562037c2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,38 @@ + + +### Summary + +My PR... + +### Related PRs, issues, or features (optional) + +- N/A + +### Feature release date (optional) + +- N/A + +### Contributor checklist + +- [ ] I confirm that my PR meets the following: + - I signed the [Contribution License Agreement (CLA)](https://www.braze.com/docs/cla). + - My style and voice follows the [Braze Style Guide](https://docs.google.com/document/u/2/d/e/2PACX-1vTluyDFO3ZEV7V6VvhXE4As_hSFwmnFFdU9g6_TrAYTgH1QmbRoEDDdn5GzKAB9vdBbIdyiFdoaJcNk/pub). + - My content contains correct spelling and grammar. + - All links are working correctly. + - If I renamed or moved a file or directory, I set up [URL redirects](https://www.braze.com/docs/contributing/content_management/redirecting_urls) for each file. + - If I updated or replaced an image, I did not remove the original image file from the repository. (For more information, see [Updating an image](https://www.braze.com/docs/contributing/content_management/images/#updating-an-image)). + - If my PR is related to a paid SKU, third party, SMS, AI, or privacy, I have received written approval from Braze Legal. + +### Submitting for review + +If your PR meets the above requirements, select **Ready for review**, then add a reviewer: +- **Non-Braze contributors:** Add `braze-inc/docs-team` as the reviewer. +- **Braze employees:** Have any relevant subject matter experts (like engineers or product managers) review your work first, then add the [tech writer assigned to your specific vertical](https://confluence.braze.com/pages/viewpage.action?pageId=75039896). If you're not sure which tech writer to add, you can add `braze-inc/docs-team` instead. + +Thanks for contributing! We look forward to reading your work. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 3fc314ba800..00000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,78 +0,0 @@ -# Pull Request/Issue Resolution - -#### Description of Change: -> I'm changing..... (could be a link, a new image, a new section, etc.)... because... - -Closes #**ISSUE_NUMBER_HERE** - -#### 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](https://www.braze.com/docs/cla/). -- [ ] 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 -
- -- [Writing Style Guide](https://docs.google.com/document/d/e/2PACX-1vTluyDFO3ZEV7V6VvhXE4As_hSFwmnFFdU9g6_TrAYTgH1QmbRoEDDdn5GzKAB9vdBbIdyiFdoaJcNk/pub) -- [Image Style Guide](https://docs.google.com/document/d/e/2PACX-1vRJSkwcjmjrTfLDagZccLpOMMyh5NN5SXRZSjz12cRAHbX4OrUmhvCmYpf_p5YB-9r4_jSOQLkicQIH/pub) -- [Styling Test Page](https://www.braze.com/docs/home/styling_test_page/) - -
- -
-❗ ATTN: For PR Reviewers -
- -- [ ] Read our [Reviewing a PR page](https://github.com/Appboy/braze-docs/wiki/Reviewing-a-PR) for more on our reviewing suggestions. -- [ ] Read our [Previewing Documentation page](https://github.com/braze-inc/braze-docs/wiki/Previewing-and-Testing-Documentation) 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. -

- - - - - - - - - - - - - - - - - - - - - - - - - -
ReviewerProduct Vertical
@josh-mccrowell-brazeMonolith Deployments
Quality Infrastructure
Platform Infrastructure
Datalake
SDKs
Currents
@internetisaiahDeveloper Guide
Technology partners
Channels
@bre-fitzgeraldIntelligence
In-App Messages
Channels
Frontend Infrastructure & Experience (FIX)
@lydia-xieIngestion
Core Objects
Core Messaging
Messaging Experience
Message Components
Email (Composition and Infrastructure) (tag @rachel-feinberg for Liquid use cases)
@rachel-feinbergCustomer Lifecycle, Identity and Permissions
SMS
User Targeting
Reporting
-