Commit b6e0a3d
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
1 file changed
+24
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
0 commit comments