Skip to content

Adds pull request template #3943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 20, 2025
Merged

Adds pull request template #3943

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26b1ed7
Adds pull request template
KOTungseth Nov 14, 2025
16c70be
Changes Contribution checklist to Checklist
KOTungseth Nov 14, 2025
a3358a0
Updates summary, checklist, adds reviewers, timeline, and notes
KOTungseth Nov 19, 2025
a50e60e
Removed all sections except summary and AI disclosure questions
KOTungseth Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
Thank you for contributing to the Elastic Docs! 🎉
Use this template to help us efficiently review your contribution.
-->

## Summary
<!--
Describe what your PR changes or improves.
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.
-->

## 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:
Comment on lines +20 to +22
Copy link
Member

@bmorelli25 bmorelli25 Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. I'd comment out the instructions if we can.

Copy link
Member

@bmorelli25 bmorelli25 Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
<!--
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:

Copy link
Contributor

@leemthompo leemthompo Nov 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really sure if there's much point in specifying what model or tool one used TBH, the point is signaling what information the author isn't confident about because they relied on AI to generate it

Copy link
Contributor

@theletterf theletterf Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to know where the data might have been ingested / processed.

Copy link
Contributor

@leemthompo leemthompo Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand, just not sure if a PR template is the right place for this. I think you're getting at the fact that non-public information shouldn't be used with these tools, but it's too late if the PR is already up.

Shouldn't we have rules against using certain tools if that's the case, rather than asking for information after the fact? I'm just trying to get at the real point of this.

Copy link
Contributor

@theletterf theletterf Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What we aim to avoid is merging code / docs that might have been processed from models we haven't approved — in this case, the PR gate provides a measure of liability / transparency / honesty.

Copy link
Contributor

@leemthompo leemthompo Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about this, the more I think we should just bake this into our CLA 😄

Copy link
Contributor Author

@KOTungseth KOTungseth Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll touch base with Legal about including this in our CLA, but in the meantime, this is the verbiage Legal is going forward with to meet our policy standards.

-->