Thank you for considering contributing to Maaagic UI! We welcome contributions from everyone, whether it's a bug fix, feature enhancement, or documentation improvement.
Before you start contributing, please take a moment to review the following guidelines:
Please read and adhere to our Code of Conduct in all your interactions with the project.
If you encounter a bug while using Maaagic UI, please open an issue on GitHub and provide as much detail as possible, including steps to reproduce the bug and your environment details.
If you have ideas for new features or enhancements, feel free to open an issue on GitHub to discuss them. We appreciate your feedback and suggestions.
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure all tests pass.
- Commit your changes with clear and descriptive commit messages.
- Push your branch to your fork and submit a pull request to the main repository.
Please make sure your code adheres to the existing code style and conventions used in the project.
To set up your development environment, follow these steps:
- Clone the repository:
git clone https://github.com/muhammad-fiaz/MaaagicUI.git- Install dependencies:
cd MaaagicUI
npm install- Start the development server:
npm run dev
or
npm run tauri:devMake sure to follow the code style used in the project. You can find the project's linting and formatting rules in the .eslintrc.json and .prettierrc.json files.
By contributing to Maaagic UI, you agree that your contributions will be licensed under the project's GNU General Public License v3.0.
If you have any questions or need further assistance, feel free to reach out to us via email or open an issue on GitHub.
Thank you for your contributions!