Skip to content

Update Pull Request Template #2498

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.

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 2 commits into from
Jul 14, 2025
Merged
Changes from all commits
Commits
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
72 changes: 58 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,58 @@
<!--
Thank you for your interest in and contributing to ECS! There are a
few simple things to check before submitting your pull request that
can help with the review process. You should delete these items from
our submission, but they are here to help bring them to your attention.
-->

- Have you signed the [contributor license agreement](https://www.elastic.co/contributor-agreement)?
- Have you followed the [contributor guidelines](https://github.com/elastic/ecs/blob/main/CONTRIBUTING.md)?
- For proposing substantial changes or additions to the schema, have you reviewed the [RFC process](https://github.com/elastic/ecs/blob/main/rfcs/README.md)?
- If submitting code/script changes, have you verified all tests pass locally using `make test`?
- If submitting schema/fields updates, have you generated new artifacts by running `make` and committed those changes?
- Is your pull request against main? Unless there is a good reason otherwise, we prefer pull requests against main and will backport as needed.
- Have you added an entry to the [CHANGELOG.next.md](https://github.com/elastic/ecs/blob/main/CHANGELOG.next.md)?
<!-- Thanks for contributing to Elastic ECS! To help us review your PR effectively and efficiently, please fill out the following sections.

Before submitting, please ensure you have:

Read the [ECS Contribution Guidelines](https://github.com/elastic/ecs/blob/main/CONTRIBUTING.md).

Signed the [Contributor License Agreement (CLA)](https://www.elastic.co/contributor-agreement) if you haven't already.

Ensured your changes align with the [ECS Guidelines and Best Practices](https://www.elastic.co/docs/reference/ecs/ecs-guidelines).

Filled in all of the sections below. -->

#### 1. What does this PR do?
<!-- Clearly describe the purpose and scope of your changes.

If this PR addresses an existing issue, please link it: Fixes #ISSUE_NUMBER or Closes #ISSUE_NUMBER. -->


#### 2. Which ECS fields are affected/introduced?
<!-- List all new or modified ECS fields.

For each, briefly explain its purpose and why it's needed within ECS.

If introducing new fields or making large changes to fields, please follow the [ECS RFC process](https://github.com/elastic/ecs/blob/main/rfcs/PROCESS.md)
and consider if they are generic enough for broader use cases beyond your immediate need. -->


#### 3. Why is this change necessary?
<!-- Explain the problem this PR solves or the new functionality it enables. Provide context and use cases where these changes would be beneficial. -->


#### 4. Have you added/updated documentation?
<!-- For new schema fields and larger changes, documenting the changes are part of the RFC process.

For smaller changes, it may be sufficient for documentation to be done within the schema itself, for example in the description field.

For script / generator changes, please ensure your code is documented, and consider adding separate documentation in `docs/` for larger or more complicated changes.

If you answer N/A, please explain why documentation is not needed. -->
YES / NO / N/A

#### 5. Have you built ECS and committed any newly generated files?
<!-- Build ECS with `make`, and commit any changed files in `generated/`. -->
YES / NO

#### 6. Have you run the ECS validation tests locally?
<!-- Run tests locally with `make test` and `make check`. (Optional: Briefly describe any issues encountered or resolved during validation) -->
YES / NO

#### 7. Anything else for the reviewers?
<!-- Provide any additional context, considerations, or questions for the reviewers. Are there any specific areas you'd like particular attention paid to? -->


---

#### Commit Message
<!-- This will be used as the commit message when merging the PR. Please clearly explain what change is being changed and why. -->