add recipe guidelines - Githubissues

processwire-recipes / Recipes

Recipe Markdown files

29 stars 18 forks source link

add recipe guidelines #6

Open owzim opened 9 years ago

owzim commented 9 years ago

as README.md, in this repo and on the site under /about/faq/ or /about/contribute/

Stuff that could/should be covered, among other things:

how to separate fields properly: #1
proper tagging #2
how to format the code
keep it simple and copy-/paste-able
and so on

Whaddayathink?

marcus-herrmann commented 9 years ago

Totally. What's currently in the README and /about/contribute is the bare minimum. If you've got wording/ideas just put it directly into the site/readme.

owzim commented 9 years ago

I think the contrib guidelines should be in here, not in the pwr.com repo since the guidleines apply for the recipes not for the site. Agreed?

marcus-herrmann commented 9 years ago

:+1:

marcus-herrmann commented 9 years ago

Actually, that whole readme should. Remains of the single-repo approach.

marcus-herrmann commented 9 years ago

Can the Recipe installer blacklist certain files? In order to have the document in this repo we have to place a .md here that is not a recipe. Don't want to accidentally install it as a recipe.

owzim commented 9 years ago

The regex matches lowercase letters, numbers and dashes. I just tested, a README.md is ignored already. Sufficient for now?

marcus-herrmann commented 9 years ago

:+1: