Contributing

Thank you for your interest in Utility. This guide explains how to contribute with consistent quality and collaboration practices.

Project Principles

• Keep code quality high.
• Prefer clear and maintainable implementations.
• Document non-trivial behavior.
• Respect contributors and review feedback.

Before You Start

• Read Code Conventions.
• Read Commit Conventions.
• Sync your branch with the latest main.

Pull Request Workflow

1. Fork the repository.
2. Create a dedicated branch.
3. Implement your changes.
4. Add or update tests.
5. Run the test suite.
6. Open a pull request.

Ensure your code matches conventions and passes tests before requesting review.

Issue Guidelines

Use the provided issue templates and include enough context:

• Clear and descriptive title.
• Detailed description.
• Reproduction steps when relevant.
• Logs, screenshots, or traces when useful.

Please avoid:

• Duplicate issues.
• Off-topic requests.
• Inappropriate language.
• Disrespectful behavior.
• Incomplete reports that ignore templates.

Documentation Guidelines

Utility uses Doxygen for API documentation.

• Document public classes, functions, and modules.
• Keep descriptions concise and accurate.
• Use proper tags such as @param and @return.
• Update comments when behavior changes.

AI-assisted documentation is acceptable, but review and edit generated text before submitting.

Code Of Conduct

This project follows the Contributor Covenant. See CODE_OF_CONDUCT.md.

For unacceptable behavior, contact:

• Clément: cleme.nosp@m.nt-a.nosp@m.ntoin.nosp@m.e.xa.nosp@m.vier@.nosp@m.epit.nosp@m.ech.e.nosp@m.u
• Léo: leo.s.nosp@m.autr.nosp@m.on@ep.nosp@m.itec.nosp@m.h.eu
• Julien: julie.nosp@m.n.fe.nosp@m.rdina.nosp@m.nd@e.nosp@m.pitec.nosp@m.h.eu
• Nathan: natha.nosp@m.n.ma.nosp@m.illot.nosp@m.@epi.nosp@m.tech..nosp@m.eu