You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,9 @@ You are welcome to contribute code in order to fix a bug, to implement a new fea
39
39
40
40
### Development Instructions
41
41
42
-
To simplify the process of building this project from scratch, we provide build scripts that run all necessary steps (build, test, and release) within a containerized environment by using [Github Actions](https://github.com/features/actions) and [Act](https://github.com/nektos/act) to run all actions locally.
42
+
To simplify the process of building this project from scratch, we provide build-scripts - based on [universal-build](https://github.com/ml-tooling/universal-build) - that run all necessary steps (build, test, and release) within a containerized environment by using [Github Actions](https://github.com/features/actions) and [Act](https://github.com/nektos/act) to run all actions locally.
43
+
44
+
> _Please refer to the [documentation of universal-build](https://github.com/ml-tooling/universal-build#automated-build-pipeline-ci) for instructions on how to execute the build-scripts directly on your machine instead of using the containerized approach documented below._
| 👩💻 **Usage Questions**| <ahref="https://stackoverflow.com/questions/tagged/ml-tooling"title="Open Question on Stackoverflow"><imgsrc="https://img.shields.io/badge/stackoverflow-ml--tooling-orange.svg"></a> <ahref="https://gitter.im/ml-tooling/lazydocs"title="Chat on Gitter"><imgsrc="https://badges.gitter.im/ml-tooling/lazydocs.svg"></a> |
72
72
| 🗯 **General Discussion**| <ahref="https://gitter.im/ml-tooling/lazydocs"title="Chat on Gitter"><imgsrc="https://badges.gitter.im/ml-tooling/lazydocs.svg"></a> <ahref="https://twitter.com/mltooling"title="ML Tooling on Twitter"><imgsrc="https://img.shields.io/twitter/follow/mltooling.svg?style=social"></a>|
73
-
| ❓ **Other Requests**| <ahref="mailto:[email protected]"title="Email ML Tooling Team"><imgsrc="https://img.shields.io/badge/email-ML Tooling-green?logo=mail.ru&style=flat-square&logoColor=white"></a> |
73
+
| ❓ **Other Requests**| <ahref="mailto:[email protected]"title="Email ML Tooling Team"><imgsrc="https://img.shields.io/badge/email-ML Tooling-green?logo=mail.ru&logoColor=white"></a> |
74
74
75
75
## Features
76
76
@@ -215,7 +215,7 @@ The full Python API documentation can be found [here](https://github.com/ml-tool
215
215
216
216
> _**Requirements**: [Docker](https://docs.docker.com/get-docker/) and [Act](https://github.com/nektos/act#installation) are required to be installed on your machine to execute the build process._
217
217
218
-
To simplify the process of building this project from scratch, we provide build-scripts that run all necessary steps (build, check, test, and release) within a containerized environment. To build and test your changes, execute the following command in the project root folder:
218
+
To simplify the process of building this project from scratch, we provide build-scripts - based on [universal-build](https://github.com/ml-tooling/universal-build) - that run all necessary steps (build, check, test, and release) within a containerized environment. To build and test your changes, execute the following command in the project root folder:
0 commit comments