From 320af01722ebe719d80fb14ff90d09f97b2d5faa Mon Sep 17 00:00:00 2001 From: Rafael Vasquez Date: Wed, 9 Mar 2022 11:52:05 -0500 Subject: [PATCH] Add dev doc links to CONTRIBUTING.md Resolves a task from #304 --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1c7bff6..a5194b99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,6 +32,14 @@ maintainers of each component affected. For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page. +## Getting Started + + **MLX Dashboard Web UI** +- Information regarding configuration, deployment, and development setup can be found [here](https://github.com/machine-learning-exchange/mlx/blob/main/dashboard/origin-mlx/README.md). + +**MLX API** +- Quickstart and development setup documentation can be found [here](https://github.com/machine-learning-exchange/mlx/tree/main/api). + ## Legal Each source file must include a license header for the Apache @@ -72,14 +80,6 @@ git commit -s ## Communication Please feel free to connect with us on our [Slack channel](https://lfaifoundation.slack.com/archives/C0264LKNH63). -## Setup -**FIXME** Please add any special setup instructions for your project to help the developer -become productive quickly. - -## Testing -**FIXME** Please provide information that helps the developer test any changes they make -before submitting. - ## Coding style guidelines **FIXME** Optional, but recommended: please share any specific style guidelines you might have for your project.