From 9c76a8566b4f53b54ed71e9027fa09a42d390285 Mon Sep 17 00:00:00 2001 From: Muhammad Fiaz Date: Sun, 11 Feb 2024 17:00:05 +0530 Subject: [PATCH] Create CONTRIBUTING.md added guidelines --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1b295d1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing to Maaagic UI + +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: + +## Code of Conduct + +Please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions with the project. + +## How Can I Contribute? + +### Reporting Bugs + +If you encounter a bug while using Maaagic UI, please [open an issue](../../issues) on GitHub and provide as much detail as possible, including steps to reproduce the bug and your environment details. + +### Suggesting Enhancements + +If you have ideas for new features or enhancements, feel free to [open an issue](../../issues) on GitHub to discuss them. We appreciate your feedback and suggestions. + +### Contributing Code + +1. Fork the repository. +2. Create a new branch for your feature or bug fix. +3. Make your changes and ensure all tests pass. +4. Commit your changes with clear and descriptive commit messages. +5. 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. + +## Development Setup + +To set up your development environment, follow these steps: + +1. Clone the repository: + +```bash + git clone https://github.com/muhammad-fiaz/MaaagicUI.git +``` +2. Install dependencies: + +```bash +cd MaaagicUI +npm install +``` +3. Start the development server: +```bash +npm run dev +or +npm run tauri:dev +``` +## Code Style +Make 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. + +## License +By contributing to Maaagic UI, you agree that your contributions will be licensed under the project's GNU General Public License v3.0. + +## Contact +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!