Contributing Guide

We welcome contributions that enhance developer productivity, security, and accessibility. Please follow the guidelines below to ensure a smooth review process.

Code of Conduct

By participating in this project you agree to uphold our values of respect, inclusivity, and professionalism. Reports of unacceptable behavior can be sent to diogo.debastos.ribeiro@gmail.com.

Development Workflow

1. Create an Issue – Describe the bug or feature request and gather feedback before implementation.
2. Fork and Branch – Use descriptive branch names such as feature/audit-report-export or fix/windows-install-path.
3. Implement Changes – Follow the coding standards outlined in the repository README and include comprehensive tests.
4. Run Tests – Execute pytest and any relevant linters before opening a pull request.
5. Submit Pull Request – Reference the related issue, include test evidence, and request a review from maintainers.

Commit Message Convention

All commits must use the Conventional Commits format:

<type>(<scope>): <description>

Valid types include feat, fix, docs, style, refactor, test, and chore.

Pull Request Checklist

• [ ] Tests added or updated.
• [ ] Documentation updated with new behavior.
• [ ] CI workflows pass successfully.
• [ ] No secrets or sensitive data included.

Thank you for helping build a reliable and scalable productivity toolkit!