Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 3.01 KB
Raw

Contributing to MMaterial

Thank you for considering contributing to our project! We value your time and effort in improving this project, and we want to ensure that the contributions align with the project's goals and standards. Below are the guidelines for contributing effectively.

Table of Contents

  1. Getting Started
  2. Coding Conventions
  3. Development Environment
  4. Submitting Contributions
  5. Code of Conduct

Getting Started

  1. Fork the Repository
    Begin by forking this repository and cloning your fork locally.

  2. Create a Branch
    Use a descriptive branch name to explain the feature or fix you are working on, e.g., feature/new-feature or bugfix/fix-issue.

  3. Stay Up-to-Date
    Regularly pull changes from the main branch to avoid merge conflicts.

Coding Conventions

To maintain consistency across the codebase, we adhere to Qt's QML Coding Conventions and Qt Quick Best Practices. Please review and follow the guidelines outlined in the official documentation:

Key points to remember:

  • Use descriptive, camelCase names for variables and functions.
  • Ensure proper indentation.
  • Avoid unnecessary bindings; keep expressions simple.
  • Use parent sparingly and thoughtfully.
  • Make sure to declare types in JS instead of using var.

Development Environment

This project targets the newest version of Qt available. All contributors should:

  • Use the latest stable or development version of Qt.
  • Test code on the newest features and APIs introduced in the latest Qt release.
  • Avoid deprecated or obsolete functions.

If a feature requires the use of a specific Qt version, clearly document this in your pull request.

Submitting Contributions

  1. Open an Issue
    Before starting major changes, create an issue to discuss your plans. Ensure your contribution aligns with the project's roadmap.

  2. Make Atomic Commits
    Write meaningful commit messages and keep changes focused. Each commit should ideally represent a single task or improvement.

  3. Follow the Pull Request Template
    When submitting a pull request:

    • Reference the issue number (if applicable).
    • Explain the changes you made and why they are necessary.
    • Include any relevant screenshots or logs.

Code of Conduct

By contributing to this project, you agree to uphold the values of inclusivity, respect, and collaboration. Please treat others with kindness and patience.

For more details, please refer to the Code of Conduct.

We appreciate your contributions and look forward to collaborating with you to improve [Your Project Name]! If you have any questions, feel free to open a discussion or contact the maintainers. Happy coding! 😊