Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (45 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 3.16 KB

Contributing to YUI-MHCP

Thank you for your interest in contributing to this project! Before submitting your contributions, please take a moment to read through this document.

Project Overview

YUI-MHCP is a personal project focusing on various Deep Learning applications. As such, please understand that:

  • Updates, reviews, and responses to issues/pull requests are handled during my free time, so please be patient
  • This project is part of a global personal project that may include future commercial applications
  • Your contribution will be added to all other repositories (if it is part of common shared modules)
  • All contributions require signing the Contributor License Agreement (CLA)

Contributor License Agreement

This project uses a Contributor License Agreement (CLA) that allows:

  • You to retain rights to your contributions
  • Me to use, modify, and potentially relicense those contributions

This is especially important if your contribution concerns generic code shared between multiple repositories of the project. This requires me to have the rights to adapt your contribution to be fully compatible with the other repositories.

Important: By submitting any contribution to this project, you agree to the terms outlined in the CLA. This ensures I can continue to develop this project in any direction, including commercial applications, while maintaining the project's open-source nature through the AGPL v3.0 license.

Code of Conduct

Please respect the following guidelines to keep the project safe, and favorable for innovations and collaborations !

Expected Behavior

  • Maintain a respectful and inclusive environment
  • Provide constructive feedback
  • Be open to different viewpoints and experiences
  • Focus on what is best for the community and project

Unacceptable Behavior

  • Use of sexualized language or imagery
  • Trolling, insulting comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information without explicit permission
  • Other conduct which could reasonably be considered inappropriate

Development Guidelines

Please follow as much as possible the following guidelines when developping new features ! This will ensure usability of your contribution as well as a global consistency of the codebase.

Code Style and Structure

  • Follow the existing code structure and organization, or open an issue/discussion to propose new abstractions
  • Maintain consistency with the current coding style
  • Use meaningful variable and function names
  • Keep functions focused and concise
  • Include docstrings and/or examples for all functions and classes

Pull Request Process

  1. Fork the repository and create your branch from main
  2. Ensure your code follows the style guidelines
  3. Include appropriate tests for your changes
  4. Update documentation as necessary
  5. Submit your pull request with a clear description of the changes

Getting Help

If you have questions or need clarification on any aspect of contributing, please open an issue, or send me a message 😄

Thank you for contributing to YUI-MHCP and helping make this project better! 😋