Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 2.69 KB
Raw

Contributing to MultiUI

First off, thank you for considering contributing to our project! Your contributions help make MultiUI better and more valuable to the community. Below are guidelines to help you get started.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub. When reporting a bug, please include:

  • A clear and descriptive title.
  • A description of the steps to reproduce the bug.
  • The expected behavior and the actual behavior.
  • Any relevant logs, screenshots, or error messages.

Suggesting Enhancements

We welcome suggestions for new features or improvements. To suggest an enhancement:

  • Open an issue on GitHub with a clear title and description.
  • Explain why the enhancement would be useful.
  • Include any examples or mockups if possible.

Pull Requests

We welcome contributions via pull requests. If you'd like to make changes, please follow these steps:

  1. Fork the Repository: Create a fork of the project on GitHub.
  2. Create a Branch: Create a feature branch (git checkout -b feature/YourFeatureName) from the main branch.
  3. Make Your Changes: Implement your changes, and test them thoroughly.
  4. Commit Your Changes: Commit your changes with a descriptive commit message (git commit -m "Add feature X").
  5. Push to Your Fork: Push your changes to your forked repository (git push origin feature/YourFeatureName).
  6. Open a Pull Request: Open a pull request on the main repository, detailing what changes you made and why.

Code Style

  • Please follow the coding conventions used in the project. This includes formatting, naming conventions, and best practices.
  • Ensure your code is well-documented, with comments where necessary.

Testing

  • If applicable, add tests to ensure your changes are functioning as expected.
  • Run all tests to confirm that your changes do not break existing functionality.

Documentation

  • Update the documentation to reflect any changes or additions.
  • Ensure that any new features or APIs are clearly documented.

Communication

  • Be respectful and considerate in your communications with others.
  • Use the project's communication channels (issue tracker, mailing list, etc.) appropriately.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the standards of behavior we expect from all contributors.

Thank You!

Thank you for your interest in contributing to our project. Your support and efforts are greatly appreciated. Together, we can make this project better!

For any further questions, please contact maintainers@example.com.