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

Improve pull request template #2083

Closed
Rebits opened this issue Oct 20, 2021 · 4 comments · Fixed by #4881
Closed

Improve pull request template #2083

Rebits opened this issue Oct 20, 2021 · 4 comments · Fixed by #4881
Assignees

Comments

@Rebits
Copy link
Member

Rebits commented Oct 20, 2021

Description

It is necessary to create a standard PR template to facilitate the task of QA by external reviewers. Some of the points that this new template should incorporate are the following:

  • Related wazuh-qa issue.

  • Description

    • Wazuh development information
    • Wazuh branch
    • Version
    • Package link if applicable
  • Testing
    The author of the PR should include a full report, proving that new development works correctly. This should follow developer guidelines standards

  • Other information necessary to correctly run new developments

@Rebits Rebits self-assigned this Oct 20, 2021
@Rebits Rebits changed the title Improve pull request templates Improve pull request template Oct 20, 2021
@jmv74211 jmv74211 assigned jmv74211 and unassigned Rebits May 11, 2022
@damarisg damarisg self-assigned this Jan 25, 2024
@damarisg
Copy link
Member

damarisg commented Jan 25, 2024

I propose a new template after last changes in our team.

Remove

  • Table of related issues to show a related issue we must use the PR Development section to link a branch, pull request or issue.
  • Current Added, Updated and Deleted section because each change is showed in the Files section.

Add

  • Description: It must contain a brief detail and the approach applied. Additionally, you must add the version with the package used and loaded.

  • Testing Performed: Contains executions as evidence that everything works correctly.
    | Validation | Jenkins | Local | OS | Commit | Notes |
    |--------------------|-----------|---------|--------|-----|--------|
    | | ⚫⚫ | ⚫⚫ | | | Nothing to highlight |

    Where:
    - Validation contains the tests where the changes applied and any impact it may have.
    - Jenkins and Local should add 2 executions with their reports.
    - OS: must run on each supported operating system.

Note:

  • You must assign yourself the PR if you are working on it.

@damarisg damarisg linked a pull request Jan 25, 2024 that will close this issue
@QU3B1M
Copy link
Member

QU3B1M commented Jan 29, 2024

LGTM!

1 similar comment
@QU3B1M
Copy link
Member

QU3B1M commented Jan 29, 2024

LGTM!

@davidjiglesias
Copy link
Member

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants