Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 1.41 KB

Contribution Guidelines

We are always open to accepting any potential contributions. Here is how you can contribute:

  1. Fork the repository
  2. Clone your forked repository
git clone https://github.com/your-username/repository-name.git
  1. Create your feature branch
git checkout -b feature/AmazingFeature
  1. Install dependencies for both mlflow and mlflow-site directories
cd /mlflow && npm install
cd ../mlflow-site && npm install
  1. Start the MLflow Tracking Server
cd ../mlflow && npm run docker

This will launch the MLflow UI on your local machine at http://localhost:5001.

  1. Make your changes

  2. Run ESLint to check code style

npm run lint
  1. Run tests to ensure your changes don't break existing functionality

    (Make sure you have mlflow UI server running on port 5002. We set 5002 as our default port for testing.)

cd /mlflow && npm run dockerTest # Run this in a separate terminal
npm run test

This will launch the MLflow UI on your local machine at http://localhost:5002, and run the Jest tests.

  1. Add and commit your changes

If the tests all pass:

git add .
git commit -m 'Add AmazingFeature'
  1. Push to the branch
git push origin feature/AmazingFeature
  1. Open a Pull Request

Note: Please ensure your code adheres to our style guidelines and includes appropriate documentation for any new features.