Contributing to wazuh-dfn¶

Thank you for your interest in contributing to wazuh-dfn! This document provides guidelines and instructions for contributing to the project.

Development Setup¶

Clone the repository:

git clone https://github.com/ZIMK/wazuh-dfn.git
cd wazuh-dfn

Install PDM (Python Dependency Manager):

pip install pdm

Install project with development dependencies:

pdm install

Code Style¶

Follow PEP 8 guidelines with a line length of 120 characters
Use type hints for all function parameters and return values
Write docstrings for all public functions and classes (Google docstring format)
Use black for code formatting
Use ruff for linting
Properly type all async functions with appropriate return types

Testing¶

Run the test suite:

pdm run pytest

Ensure test coverage:

pdm run pytest --cov=src/wazuh_dfn

Run async-specific tests:

pdm run pytest --asyncio-mode=auto tests/

Pull Request Process¶

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Run the test suite and linting tools
Update documentation if needed
Commit your changes (git commit -m 'Add amazing feature')
Push to your fork (git push origin feature/amazing-feature)
Open a Pull Request

Commit Messages¶

Use the present tense (“Add feature” not “Added feature”)
Use the imperative mood (“Move cursor to…” not “Moves cursor to…”)
Limit the first line to 72 characters
Reference issues and pull requests in the body

Development Workflow¶

Pick an issue to work on or create a new one
Discuss the proposed changes in the issue
Fork and clone the repository
Create a new branch for your changes
Make your changes
Write or update tests
Update documentation
Submit a pull request

Code Review Process¶

At least one maintainer must review and approve the changes
All automated checks must pass
Documentation must be updated if needed
Test coverage should not decrease

Release Process¶

Update version in pyproject.toml
Update CHANGELOG