Skip to content
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

github: unify PR description and commit message #36205

Merged
merged 1 commit into from
Aug 3, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Aug 1, 2023

What does this PR do?

To improve the quality of commit messages in the revision history, indicate that the commit message will be part of the PR review process and integrate the WHAT and WHY questions in the change explanation.

Remove the checklist item for PR title and description as it becomes redundant with this new text.

Why is it important?

Included in the text above.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.
  • I have made my commit title and message explanatory about the purpose and the reason of the change

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

To improve the quality of commit messages in the revision history,
indicate that the commit message will be part of the PR review process
and integrate the WHAT and WHY questions in the change explanation.

Remove the checklist item for PR title and description as it becomes
redundant with this new text.
@efd6 efd6 self-assigned this Aug 1, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Aug 1, 2023
@efd6 efd6 marked this pull request as ready for review August 1, 2023 21:53
@efd6 efd6 requested a review from a team as a code owner August 1, 2023 21:53
@efd6 efd6 requested review from rdner and faec August 1, 2023 21:53
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@mergify
Copy link
Contributor

mergify bot commented Aug 1, 2023

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @efd6? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-08-01T21:53:30.310+0000

  • Duration: 9 min 39 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)


<!-- Mandatory
Explain here the changes you made on the PR. Please explain the WHAT: patterns used, algorithms implemented, design architecture, message processing, etc.
-->
Explain here the changes you made on the PR.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would remove this one as we already have "Please explain:" just after.
Otherwise everything is good to me!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess this is a matter of style. The text here reflects the text that was previously there, just now on two lines. The thinking that I had with retaining the text as it is was that the first line is the overall goal of the section, while the second is the specific parts that should be addressed. If you still want me to remove it given that, I'm happy to.

Copy link
Member

Choose a reason for hiding this comment

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

I don't have a problem with it as it is, but if you can make it shorter people are more likely to read it :p

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree about that. We need to have reviewers on board to point to this, so the main issue is whether that will happen.

@rdner rdner removed their request for review August 3, 2023 12:03
@efd6 efd6 merged commit 76a7aad into elastic:main Aug 3, 2023
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
To improve the quality of commit messages in the revision history,
indicate that the commit message will be part of the PR review process
and integrate the WHAT and WHY questions in the change explanation.

Remove the checklist item for PR title and description as it becomes
redundant with this new text.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants