Contributing to OMNI FLUX

We appreciate your interest in contributing to OMNI FLUX! Whether you're fixing bugs, improving documentation, or proposing new features, your contributions are valuable.

🚀 How to Contribute

1. Fork the Repository: Start by forking the main OMNI FLUX repository to your GitHub account.

2. Clone Your Fork: Clone your forked repository to your local machine:

   git clone https://github.com/YOUR_USERNAME/omni-flux.git
   cd omni-flux

3. Create a Branch: Create a new branch for your changes:

   git checkout -b feature/your-feature-name

4. Make Changes: Implement your changes, ensuring code quality and adherence to project standards.

5. Test Your Changes: Run tests to ensure your changes don't break existing functionality:

   yarn test

6. Commit Your Changes: Commit your changes with a descriptive message:

   git commit -m "feat: add awesome new feature"

   Follow the Conventional Commits specification for commit messages.

7. Push to Your Fork: Push your changes to your forked repository:

   git push origin feature/your-feature-name

8. Submit a Pull Request: Open a pull request from your branch to the main branch of the OMNI FLUX repository. Provide a clear description of your changes.

📝 Code Style

• Follow the existing code style (ESLint, Prettier configured).

• Write clear and concise code with comments where necessary.

• Ensure TypeScript types are used effectively.

🐛 Reporting Bugs

• Use the GitHub Issues tab to report bugs.

• Provide detailed steps to reproduce the bug.

• Include information about your environment (OS, Node version, etc.).

✨ Feature Requests

• Suggest new features via GitHub Issues.

• Explain the problem the feature solves and its potential benefits.

Thank you for contributing to OMNI FLUX! 🙏