Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
173 lines (134 loc) · 4.69 KB

CONTRIBUTING.md

File metadata and controls

173 lines (134 loc) · 4.69 KB
Raw

Contributing to OMEX 🚀

Thank you for your interest in contributing to OMEX – AI Code Optimization Platform!❤️ We welcome contributions of all kinds – bug fixes, feature enhancements, documentation improvements, and more.
This guide will help you get started.

📜 Code of Conduct

Please note that this project follows a Code of Conduct.
By participating, you are expected to uphold this code. Be respectful and professional in all interactions.

✅ Contribution Guidelines

  • Follow existing code style and folder structure.
  • Write clear, concise commit messages.
  • Add comments where necessary for better understanding.
  • Test your changes locally before submitting a PR.
  • Keep PRs focused and small (easier to review & merge).

🔍 Areas You Can Contribute To

  • 🐛 Bug Fixes: Resolve open issues or report new ones.
  • ✨ New Features: Extend platform functionality (e.g., new optimization tools).
  • 📖 Documentation: Improve README, contributing guide, or inline code docs.
  • 🎨 UI/UX: Enhance frontend with better design or animations.
  • ⚡ Performance: Optimize backend or frontend performance.

🛠 How to Contribute

Need help getting started?

On the website, you’ll find a Contributor Guide page in the navigation bar under the "Company" section.
This interactive guide covers all the essential steps, Git commands, FAQs, and resources you need to make your first contribution smoothly.

Be sure to check it out for a visual walkthrough and quick reference while you contribute!

1. Fork the Repository

  • Navigate to the OMEX Repository
  • Click Fork to create your own copy of the repository.

2. Clone Your Fork

git clone https://github.com/<your-username>/Omex.git
cd Omex

3. Create a Branch

Always work on a new branch:

git checkout -b feature/your-feature-name

Examples of branch names:

  • feature/code-optimizer-ui
  • fix/complexity-analysis-bug

4. Install Dependencies

Set up the project locally:

Backend

cd BackEnd
npm install

Frontend

cd ../Frontend
npm install

5. Set Environment Variables

  • Create .env files in BackEnd and Frontend following the instructions in the README.

6. Make Your Changes

  • Implement your feature, fix, or improvement.
  • Follow clean coding standards and best practices.
  • Ensure code is optimized and well-commented.

7. Run Tests

Before pushing:

# Backend
cd BackEnd
npm test

# Frontend
cd ../Frontend
npm run test

8. Commit Your Changes

Write meaningful commit messages:

git add .
git commit -m "✨ Added complexity analysis improvements"

9. Push Your Branch

git push origin feature/your-feature-name

10. Open a Pull Request

  • Go to your fork on GitHub
  • Click Compare & Pull Request
  • Add a detailed description of your changes

🛠️ Development Workflow

  1. Create a branch for your contribution: 
    git checkout -b feature/your-feature-name
  2. Make changes (ensure code follows best practices).
  3. Commit your changes: 
    git commit -m "Add: description of your changes"
  4. Push changes to your fork: 
    git push origin feature/your-feature-name
  5. Open a Pull Request (PR):
    • Go to the original repo: OMEX
    • Click New Pull Request
    • Provide a clear title & description

📜 Commit Message Convention

Use the following format for commits:

type: short description

Types:

  • fix: – Bug fixes
  • feat: – New features
  • docs: – Documentation changes
  • style: – Code style/formatting (no logic changes)
  • refactor: – Refactored code without behavior change
  • test: – Adding or modifying tests
  • chore: – Maintenance or non-production changes

Example:

feat: add code comparison tool

📬 Questions?

If you face any issues while contributing:

Built with ❤️ by the OMEX Team. # Contributing to OMEX 🚀

🌟Thank you for your interest in contributing to OMEX - AI Code Optimization Platform!
We welcome contributions from everyone, whether it’s fixing a bug, improving documentation, or adding new features.
This document provides guidelines to help you get started.Together, we make coding smarter, cleaner, and faster. 🚀