This commit is contained in:
Recolic Keghart
2022-02-20 16:56:42 +08:00
71 changed files with 1313 additions and 508 deletions

View File

@@ -1,16 +1,30 @@
# CONTRIBUTING Guide
## 如何贡献
直接修改/添加做菜指南并提交 Pull request 即可。
在写新菜谱时,请复制并修改已有的模板: [示例菜](./dishes/template/示例菜/示例菜.md)。
记得在提交 Pull Request 前同样更新一下 Readme.md 里的引用。
## 为什么会有这个项目 (Motivation)
Add some motivation here. @Anduin
- Anduin的Motivation
Recolic的个人观点: 菜谱的目的是复现一道菜。在做菜的过程中,菜会受厨师的经验、主观判断、生活经历而改变
最近在家隔离,出不了门。只能宅在家做饭了。作为程序员,我偶尔在网上找找菜谱和做法。但是这些菜谱往往写法千奇百怪,经常中间莫名出来一些材料。对于习惯了形式语言的程序员来说极其不友好
所以,我计划自己搜寻菜谱和并结合实际做菜的经验,准备用更清晰精准的描述来整理常见菜的做法,以方便程序员在家做饭。
- Recolic的个人观点
菜谱的目的是复现一道菜。在做菜的过程中,菜会受厨师的经验、主观判断、生活经历而改变。
但是为了达到`复现一道菜`的目的,菜谱必须是客观的,也就意味着菜谱本身不应受厨师的经验、主观判断而改变。
菜的创作者(厨师)、菜的记录者(菜谱)、菜的生产者(饥饿的程序员、炒菜机器人)应当是三个不同的角色。如果生产者偶尔心情愉悦,可以兼职为创作者。记录者是为生产者服务的。
## 内容注意事项
## 内容规范
此仓库中的菜谱需要满足以下规范,不符合规范的菜谱将不会被合并到代码库中。
本项目的Motivation要求菜谱满足以下规范,不符合规范的菜谱将不会被合并到代码库中。如果以下内容不易理解, 不必担心. 仓库管理者会在你的PR中提出建议, 并协助修改。
1. 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。
@@ -67,5 +81,8 @@ Recolic的个人观点: 菜谱的目的是复现一道菜。在做菜的过程
变软 变硬
```
3. 菜品的制作步骤应当完整(complete)。
3. 菜品的`制作步骤`应当完整(complete)。这意味着, 在执行完所有操作步骤后, 菜品已经被完成。
4. 菜品的`原材料与工具`应当完整(complete)且必要。这意味着, 在执行完所有操作步骤后, 没有原材料被遗漏不用。在执行操作步骤时, 没有用到`原材料与工具`中未提到的物品。