From f32d84a7b7dde3957f5f013813bc615219042570 Mon Sep 17 00:00:00 2001 From: Cody <54814569+lostmygithubaccount@users.noreply.github.com> Date: Mon, 16 Nov 2020 14:50:51 -0800 Subject: [PATCH] Update templates.md (#6) --- website/docs/templates/templates.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/website/docs/templates/templates.md b/website/docs/templates/templates.md index 9e889d7..8e0698c 100644 --- a/website/docs/templates/templates.md +++ b/website/docs/templates/templates.md @@ -24,10 +24,33 @@ keywords: - None -## Adding a new template +## Contributing (a template) -Fork the base template, following the required structure and adapting the template. Make a PR here to add it to the appropriate list. +Copy the base template, adapting it for your scenario and following all guidelines below. Make a PR here to add it to the appropriate list. + +### Principle + +Less but better. + +### Spirit + +The spirit of AML templates includes: + +- frequent and comprehensive testing +- clear separation of cloud code (job definition) and user code +- users can get up and running in 10 minutes with their own data/code + +### General rules + +- minimal prose +- minimalist code +- workflows re-run without failing at least daily ### Enforced naming +- repo should be published to https://github.com/Azure - repo should be named `azureml-template-*`, using hyphens to separate words + +### Additional guidance + +It is best to follow the guidance from the [example repo](https://github.com/Azure/azureml-examples) where applicable.