== Orchard AutoPkg Recipe Guidelines ==
* Recipe filenames should be named after the software with spaces expressed as underscores e.g. {{{An_Amazing_Widget.munki.recipe}}}
* '''All''' recipes should begin with an Attribution dict, containing a Copyright string and an Author dict with Name, Email and Github strings e.g.:
{{{
Attribution
Copyright
University of Oxford 2016
Author
Name
Bilbo Baggins
Email
bilbo.baggins at it.ox.ac.uk
Github
bilbob
}}}
* All recipes must have a useful {{{Description}}}
* Recipe {{{Identifier}}} must be in the form {{{uk.ac.ox.orchard..}}}
* For .munki recipes
* In the {{{Input}}} dict:
* {{{NAME}}} should be set to the name of the software in title case with spaces expressed as underscores
* {{{MUNKI_REPO_SUBDIR}}} (which should be used as the repo_subdirectory in the !MunkiImporter processor) should be set to {{{%NAME%}}} (unless the software forms part of a suite of connected apps e.g. Microsoft_Office_2016
* There should be a {{{pkginfo}}} dict with the following:
* A {{{catalogs}}} array containing 'testing' (can be set to 'unstable' whilst doing internal testing but must be changed once in the auto-build)
* A valid {{{category}}} (see this [[AutoPkg/Contributing/Categories|list of categories]])
* A short {{{description}}} which should be free of marketing speak but should concisely describe the app and its function(s)
* A {{{developer}}} (try to ensure that this matches other software by the same developer in the repo)
* A {{{display_name}}} either set to {{{%NAME%}}} or the Name with spaces if more than one word.
* A {{{name}}} set to {{{%NAME%}}}
* {{{unattended_install}}} set to {{{True}}}