Skip to content

Commit a3358a0

Browse files
committed
Updates summary, checklist, adds reviewers, timeline, and notes
1 parent 16c70be commit a3358a0

File tree

1 file changed

+35
-15
lines changed

1 file changed

+35
-15
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,9 @@ Use this template to help us efficiently review your contribution.
44
-->
55
## Summary
66

7-
Briefly describe what your PR changes or improves.
8-
If your contribution fixes an issue, please link it here.
9-
10-
### Checklist
11-
12-
Before you submit your PR, please confirm the following:
13-
14-
- [ ] My changes are clear, accurate, and technically correct.
15-
- [ ] I verified the Markdown renders correctly.
16-
- [ ] I avoided duplicating existing content.
17-
- [ ] I made the changes in the correct section or file.
18-
- [ ] I followed the style and structure of the surrounding documentation.
19-
20-
To learn more, check [Contribute to Elastic documentation](https://www.elastic.co/docs/contribute-docs).
7+
Describe what your PR changes or improves.
8+
Describe the reason you are making this change.
9+
If your PR fixes an issue, link it here.
2110

2211
## Generative AI disclosure
2312

@@ -29,4 +18,35 @@ To help us ensure compliance with the Elastic open source and documentation guid
2918

3019
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.).
3120

32-
Tool(s) and model(s) used:
21+
Tool(s) and model(s) used:
22+
23+
---
24+
25+
## Checklist
26+
27+
Before requesting a review, please confirm the following:
28+
29+
- [ ] PR follows the [Elastic Docs contribution guidelines](https://www.elastic.co/docs/contribute-docs)
30+
- [ ] Content has been proofread for grammar, spelling, and clarity
31+
- [ ] Any code examples have been tested and verified
32+
- [ ] Images, screenshots, or diagrams included where necessary
33+
- [ ] Links and references are correct and functioning
34+
35+
--
36+
37+
## Reviewers and timeline
38+
39+
To identify the reviewers and expected timelines for your PR, use the table.
40+
41+
If you plan to review the content within the review timeline, check the box next to your name.
42+
43+
| Role | Reviewer | Review timeline |
44+
|------|---------|------------------------|
45+
| Technical review | @username [ ] | Date |
46+
| Writer review | @username [ ] | Date |
47+
48+
--
49+
50+
## Additional notes
51+
52+
Add any additional context or information for reviewers here.

0 commit comments

Comments
 (0)