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

Update GitHub pull request template #539

Merged
merged 1 commit into from
Jan 27, 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
111 changes: 56 additions & 55 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,77 @@
|Related issue|
|---|
||
## Description

<!--
This template reflects sections that must be included in new Pull requests.
Contributions from the community are really appreciated. If this is the case, please add the
"contribution" to properly track the Pull Request.
Provide a brief description of the problem this pull request addresses. Include relevant context to help reviewers understand the purpose and scope of the changes.

Please fill the table above. Feel free to extend it at your convenience.
If this pull request resolves an existing issue, reference it here. For example:
Closes #<issue_number>
-->

## Description
## Proposed Changes

<!--
Add a clear description of how the problem has been solved.
Summarize the changes made in this pull request. Include:
- Features added
- Bugs fixed
- Any relevant technical details
-->

## Configuration options
### Results and Evidence

<!--
When proceed, this section should include new configuration parameters.
Provide evidence of the changes made, such as:
- Logs
- Screenshots
- Before/after comparisons
-->

## Logs/Alerts example
### Artifacts Affected

<!--
Paste here related logs and alerts
List the artifacts impacted by this pull request, such as:
- Executables (specify platforms if applicable)
- Default configuration files
- Packages
-->

## Tests
### Configuration Changes

<!--
Depending on the affected components by this PR, the following checks should be selected and marked.
If applicable, list any configuration changes introduced by this pull request, including:
- New configuration parameters
- Changes to default values
- Backward compatibility notes
-->

<!-- Minimum checks required -->
- Compilation without warnings in every supported platform
- [ ] Linux
- [ ] Windows
- [ ] MAC OS X
- [ ] Source installation
- [ ] Package installation
- [ ] Source upgrade
- [ ] Package upgrade
- [ ] Review logs syntax and correct language
- [ ] QA templates contemplate the added capabilities

<!-- Depending on the affected OS -->
- Memory tests for Linux
- [ ] Scan-build report
- [ ] Coverity
- [ ] Valgrind (memcheck and descriptor leaks check)
- [ ] Dr. Memory
- [ ] AddressSanitizer
- Memory tests for Windows
- [ ] Scan-build report
- [ ] Coverity
- [ ] Dr. Memory
- Memory tests for macOS
- [ ] Scan-build report
- [ ] Leaks
- [ ] AddressSanitizer

<!-- Checks for huge PRs that affect the product more generally -->
- [ ] Retrocompatibility with older Wazuh versions
- [ ] Working on cluster environments
- [ ] Configuration on demand reports new parameters
- [ ] The data flow works as expected (agent-manager-api-app)
- [ ] Added unit tests (for new features)
- [ ] Stress test for affected components

<!-- Ruleset required checks, rules/decoder -->
- Decoder/Rule tests
- [ ] Added unit testing files ".ini"
- [ ] runtests.py executed without errors
### Documentation Updates

<!--
If applicable, list the sections of documentation that have been updated as part of this pull request.
-->

### Tests Introduced

<!--
If applicable, describe any new unit or integration tests added as part of this pull request. Include:
- Scope of the tests
- Any relevant details about test coverage
-->

## Review Checklist

<!--
List any manual tests completed to verify the functionality of the changes. Include any manual tests that are still required for final approval.
-->

- [ ] Code changes reviewed
- [ ] Relevant evidence provided
- [ ] Tests cover the new functionality
- [ ] Configuration changes documented
- [ ] Developer documentation reflects the changes
- [ ] Meets requirements and/or definition of done
- [ ] No unresolved dependencies with other issues
- [ ] ...

<!--
Include any additional information relevant to the review process.
-->
Loading