@@ -9,70 +9,54 @@ We are always open to accepting any potential contributions. Here is how you can
99git clone https://github.com/your-username/repository-name.git
1010```
1111
12- 3 . Install dependencies for both mlflow and mlflow-site directories
13- 14- ``` bash
15- cd mlflow && npm install
16- cd ../mlflow-site && npm install
17- ```
18- 19- 4 . Create your feature branch
12+ 3 . Create your feature branch
2013
2114``` bash
2215git checkout -b feature/AmazingFeature
2316```
2417
25- 5 . Run MLflow Tracking Server container with Docker
18+ 4 . Install dependencies for both mlflow and mlflow-site directories
2619
2720``` bash
28- cd mlflow
29- npm run docker
21+ cd / mlflow-site && npm install
22+ cd ../mlflow && npm run docker
3023```
3124
32- This will launch the MLflow UI on your local machine at ` http://localhost:5001 ` .
33- The port
34- ``` npm run docker ```
35- launches on can be changed in the docker-compose.yml file.
25+ This will also launch the MLflow UI on your local machine at ` http://localhost:5001 ` .
3626
37- 6 . Make your changes
27+ 5 . Make your changes
3828
39- 7 . Run ESLint to check code style
29+ 6 . Run ESLint to check code style
4030
4131``` bash
4232npm run lint
4333```
4434
45- 8 . Run tests to ensure your changes don't break existing functionality
35+ 7 . Run tests to ensure your changes don't break existing functionality
4636
4737 (Make sure you have mlflow UI server running on port 5002. We set 5002 as our default port for testing.)
4838
4939``` bash
50- mlflow ui --port 5002 # Run this in a separate terminal
51- npm run test
52- ```
53- 54- Alternative Docker Approach:
55- 56- ``` bash
57- docker pull ghcr.io/mlflow/mlflow
58- docker run -p 5002:5002 ghcr.io/mlflow/mlflow:latest mlflow server --host 0.0.0.0 --port 5002
40+ cd mlflow && npm run dockerTest
5941npm run test
6042```
6143
6244This will launch the MLflow UI on your local machine at ` http://localhost:5002 ` , and run the Jest tests.
6345
64- 9 . Commit your changes
46+ 8 . Commit your changes
47+ 48+ If the tests all pass:
6549
6650``` bash
6751git commit -m ' Add AmazingFeature'
6852```
6953
70- 10 . Push to the branch
54+ 9 . Push to the branch
7155
7256``` bash
7357git push origin feature/AmazingFeature
7458```
7559
76- 11 . Open a Pull Request
60+ 10 . Open a Pull Request
7761
7862** Note:** Please ensure your code adheres to our style guidelines and includes appropriate documentation for any new features.
0 commit comments