Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (35 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 2.18 KB

Contributing to MMExD

First off, thank you for considering contributing to MMExD! It's people like you that make open source such a great community. We welcome any form of contribution, from reporting bugs and suggesting features to writing code and improving documentation.

How Can I Contribute?

Reporting Bugs

If you find a bug, please make sure to report it. To report a bug, open an issue on our GitHub repository. Please include the following information:

  • A clear and descriptive title.
  • A detailed description of the bug, including the steps to reproduce it.
  • The version of MMExD you are using.
  • Any error messages or logs you received.

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, feel free to open an issue to discuss it. We are always open to new ideas!

Code Contributions

If you want to contribute code, that's great! Here's how you can do it:

  1. Fork the repository: Start by forking the MMExD repository to your own GitHub account.

  2. Clone your fork: Clone your forked repository to your local machine.

    git clone https://github.com/CoderRony955/MMExD.git

  3. Set up the development environment: Follow the instructions in the README.md file to set up the project for local development using setup_uv.bat.

  4. Create a new branch: Create a new branch for your feature or bug fix.

    git checkout -b my-new-feature

  5. Make your changes: Make your changes to the codebase. Ensure you follow the existing code style and conventions.

  6. Test your changes: Make sure to test your changes to ensure they work as expected and don't introduce any new bugs.

  7. Commit your changes: Commit your changes with a clear and descriptive commit message.

    git commit -m "feat: Add new feature"

  8. Push to your fork: Push your changes to your forked repository.

    git push origin my-new-feature

  9. Create a Pull Request: Open a pull request from your forked repository to the main MMExD repository. Provide a clear description of the changes you have made.

Thank you for your contribution!