From 26b1ed7fa4097f9e30b42f2685a3a082ba6209bc Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Fri, 14 Nov 2025 12:24:46 -0600 Subject: [PATCH 1/4] Adds pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..6e9a430ba3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ + +## Summary + +Briefly describe what your PR changes or improves. +If your contribution fixes an issue, please link it here. + +### Contribution checklist + +Before you submit your PR, please confirm the following: + +- [ ] My changes are clear, accurate, and technically correct. +- [ ] I verified the Markdown renders correctly. +- [ ] I avoided duplicating existing content. +- [ ] I made the changes in the correct section or file. +- [ ] I followed the style and structure of the surrounding documentation. + +To learn more, check [Contribute to Elastic documentation](https://www.elastic.co/docs/contribute-docs). + +## Generative AI disclosure + +To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: + +1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? +- [ ] Yes +- [ ] No + +2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). + +Tool(s) and model(s) used: \ No newline at end of file From 16c70befebe087abaf61d040f7ac71170309cc49 Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Fri, 14 Nov 2025 12:26:03 -0600 Subject: [PATCH 2/4] Changes Contribution checklist to Checklist --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6e9a430ba3..9f8a8d743d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,7 +7,7 @@ Use this template to help us efficiently review your contribution. Briefly describe what your PR changes or improves. If your contribution fixes an issue, please link it here. -### Contribution checklist +### Checklist Before you submit your PR, please confirm the following: From a3358a06e498164455ef50035ba80165326c3e8e Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Wed, 19 Nov 2025 16:08:05 -0600 Subject: [PATCH 3/4] Updates summary, checklist, adds reviewers, timeline, and notes --- .github/PULL_REQUEST_TEMPLATE.md | 50 ++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 15 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9f8a8d743d..849bec2b11 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,20 +4,9 @@ Use this template to help us efficiently review your contribution. --> ## Summary -Briefly describe what your PR changes or improves. -If your contribution fixes an issue, please link it here. - -### Checklist - -Before you submit your PR, please confirm the following: - -- [ ] My changes are clear, accurate, and technically correct. -- [ ] I verified the Markdown renders correctly. -- [ ] I avoided duplicating existing content. -- [ ] I made the changes in the correct section or file. -- [ ] I followed the style and structure of the surrounding documentation. - -To learn more, check [Contribute to Elastic documentation](https://www.elastic.co/docs/contribute-docs). +Describe what your PR changes or improves. +Describe the reason you are making this change. +If your PR fixes an issue, link it here. ## Generative AI disclosure @@ -29,4 +18,35 @@ To help us ensure compliance with the Elastic open source and documentation guid 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). -Tool(s) and model(s) used: \ No newline at end of file +Tool(s) and model(s) used: + +--- + +## Checklist + +Before requesting a review, please confirm the following: + +- [ ] PR follows the [Elastic Docs contribution guidelines](https://www.elastic.co/docs/contribute-docs) +- [ ] Content has been proofread for grammar, spelling, and clarity +- [ ] Any code examples have been tested and verified +- [ ] Images, screenshots, or diagrams included where necessary +- [ ] Links and references are correct and functioning + +-- + +## Reviewers and timeline + +To identify the reviewers and expected timelines for your PR, use the table. + +If you plan to review the content within the review timeline, check the box next to your name. + +| Role | Reviewer | Review timeline | +|------|---------|------------------------| +| Technical review | @username [ ] | Date | +| Writer review | @username [ ] | Date | + +-- + +## Additional notes + +Add any additional context or information for reviewers here. \ No newline at end of file From a50e60e7b2b5c332e9541e4ed2abb0bccf0d2fcf Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Thu, 20 Nov 2025 11:28:35 -0600 Subject: [PATCH 4/4] Removed all sections except summary and AI disclosure questions --- .github/PULL_REQUEST_TEMPLATE.md | 44 ++++++-------------------------- 1 file changed, 8 insertions(+), 36 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 849bec2b11..5b48ef3840 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,51 +2,23 @@ Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> -## Summary +## Summary + ## Generative AI disclosure - + 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [ ] No - + ---- - -## Checklist - -Before requesting a review, please confirm the following: - -- [ ] PR follows the [Elastic Docs contribution guidelines](https://www.elastic.co/docs/contribute-docs) -- [ ] Content has been proofread for grammar, spelling, and clarity -- [ ] Any code examples have been tested and verified -- [ ] Images, screenshots, or diagrams included where necessary -- [ ] Links and references are correct and functioning - --- - -## Reviewers and timeline - -To identify the reviewers and expected timelines for your PR, use the table. - -If you plan to review the content within the review timeline, check the box next to your name. - -| Role | Reviewer | Review timeline | -|------|---------|------------------------| -| Technical review | @username [ ] | Date | -| Writer review | @username [ ] | Date | - --- - -## Additional notes - -Add any additional context or information for reviewers here. \ No newline at end of file