Skip to content

Commit b6e0a3d

Browse files
authored
Adds pull request template (#3943)
## Summary Introduces a new pull request template for the Elastic Docs repository that includes required GenAI disclosure questions. The template is designed to help internal and external contributors provide clear and accurate documentation updates while ensuring transparency around AI-assisted contributions. ## What’s changing - Adds a new PR template to .github/PULL_REQUEST_TEMPLATE.md. - Incorporates two GenAI disclosure questions drafted by Legal: - Whether a GenAI tool was used. - Which tool(s) and model(s) were used, if applicable. ## Why this change is needed The Elastic Legal and Open Source teams have requested that all public-facing repositories include standardized questions about generative AI usage in documentation contributions. These questions help us: - Maintain transparency regarding AI-assisted content. - Support responsible and high-quality use of AI for documentation. - Ensure reviewers have the context needed to evaluate contributions. - Establish consistency across Elastic open repositories, particularly as external contributors begin using AI more frequently. Adding this template to the Elastic Docs repo also helps contributors understand our expectations upfront and aligns with the AI & Docs Guidelines we’ve developed internally. ## What's needed from reviewers - Content accuracy and clarity: Does the wording in the template feel clear, welcoming, and consistent with our documentation standards? - Completeness: Are there additional checklist items or guidance we should add for contributors? ## Additional question Should we also include a separate template specifically for external contributors, or is the single unified template sufficient?
1 parent 2b155f2 commit b6e0a3d

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thank you for contributing to the Elastic Docs! 🎉
3+
Use this template to help us efficiently review your contribution.
4+
-->
5+
6+
## Summary
7+
<!--
8+
Describe what your PR changes or improves.
9+
If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change.
10+
-->
11+
12+
## Generative AI disclosure
13+
<!--
14+
To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following:
15+
-->
16+
1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
17+
- [ ] Yes
18+
- [ ] No
19+
<!--
20+
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.).
21+
22+
Tool(s) and model(s) used:
23+
-->
24+

0 commit comments

Comments
 (0)