Skip to content

Commit 3b2faf7

Browse files
committed
doc update
1 parent b2fa127 commit 3b2faf7

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,45 +18,51 @@ git checkout -b feature/AmazingFeature
1818
4. Install dependencies for both mlflow and mlflow-site directories
1919

2020
```bash
21-
cd /mlflow-site && npm install
21+
cd /mlflow && npm install
22+
cd ../mlflow-site && npm install
23+
```
24+
25+
5. Start the MLflow Tracking Server
26+
27+
```bash
2228
cd ../mlflow && npm run docker
2329
```
2430

25-
This will also launch the MLflow UI on your local machine at `http://localhost:5001`.
31+
This will launch the MLflow UI on your local machine at `http://localhost:5001`.
2632

27-
5. Make your changes
33+
6. Make your changes
2834

29-
6. Run ESLint to check code style
35+
7. Run ESLint to check code style
3036

3137
```bash
3238
npm run lint
3339
```
3440

35-
7. Run tests to ensure your changes don't break existing functionality
41+
8. Run tests to ensure your changes don't break existing functionality
3642

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

3945
```bash
40-
cd mlflow && npm run dockerTest
46+
cd /mlflow && npm run dockerTest
4147
npm run test
4248
```
4349

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

46-
8. Commit your changes
52+
9. Commit your changes
4753

4854
If the tests all pass:
4955

5056
```bash
5157
git commit -m 'Add AmazingFeature'
5258
```
5359

54-
9. Push to the branch
60+
10. Push to the branch
5561

5662
```bash
5763
git push origin feature/AmazingFeature
5864
```
5965

60-
10. Open a Pull Request
66+
11. Open a Pull Request
6167

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

0 commit comments

Comments
 (0)