diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5ebb850..87a29f5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,4 +14,4 @@ jobs: - name: Install packages run: sudo gem install mdl - name: Lint markdown files - run: mdl *.md -r ~MD029,~MD036,~MD024 + run: mdl *.md -r ~MD009,~MD029,~MD036,~MD024 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 500e3fc..3282004 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,76 @@ -# 如何贡献 +# CONTRIBUTING Guide -直接修改\添加做菜指南并提交 Pull request 即可。 +## 如何贡献 + +直接修改/添加做菜指南并提交 Pull request 即可。 在写新菜谱时,请复制并修改已有的模板: [示例菜](./dishes/template/示例菜/示例菜.md)。 记得在提交 Pull Request 前同样更新一下 Readme.md 里的引用。 + +## 内容规范 + +**菜谱提交者无需阅读此内容规范。以下内容已经以简明易懂的方式包含在示例模板中。项目的维护者会在你的PR中提出建议, 并协助修改。** + +本项目的 Motivation 要求菜谱满足以下规范,不符合规范的菜谱将不会被合并到代码库中。项目的维护者维护此文档, 作为正式的标准与共识。 + +1. 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。 + +`原材料与工具`应列出本菜品需要的除`假想已准备好的物品`外的所有原材料与厨具。 +`计算`应定量列出本菜品所需的原材料的量。(无论与人数是否相关) +`操作`应说明菜品的制作步骤。 + +2. 菜品的制作步骤应当明确(无歧义,non-ambiguous),并尽可能准确(accurate)。有歧义(ambiguous)的描述是不可接受的,而不准确(inaccurate)或不精确(imprecise)的描述是可以接受的。 + +> 不准确的菜谱会导致菜品口味有少许偏差,不明确的菜谱会导致做菜人的心态有明显不安。 + +举例:有歧义的描述 + +``` +# 解释:此处对于盐量的描述是有歧义的。 +# 因为对于某个数量的盐,用户无法得出确定的客观结论:此数量是否属于"少量"。 +加入少量盐 + +加入几滴耗油 +将锅加热至八分热 +撒上少许葱花 +煮至鸡肉断生 +``` + +举例:无歧义的描述 + +``` +# 解释:此处对于锅的温度的描述是不准确的(可能是200摄氏度左右的任何温度),但这个描述是无歧义的。 +# 因为对于锅的某个状态,用户可以进行水滴测试,并得出确定的客观结论:此状态要么符合要求,要么不符合要求。 +加热锅,直至"滴入几滴水时,水珠能够在锅上迅速滚动而不吸附" +加热锅,直至观察到莱顿弗罗斯特现象 + +加入5ml酱油 +等到水沸腾后 +继续煮,直到汤汁剩下二分之一 +煎至表面呈金黄色 +继续翻炒两分钟 + +# 食材所可能粘附的蛋液的量是确定的 +裹上蛋液 + +# 在'计算'中已提及将用到葱花的量 +撒上葱花 +``` + +考虑到现实因素,对于某些在家庭厨房中确实难以明确描述的因素,可以作为特例排除。例如 + +``` +# 在描述燃气灶火焰强度时 +文火, 小火, 中火, 大火 等 +# 在描述颜色时 +金黄色 等 +# 在描述硬度时 +变软 变硬 +``` + +3. 菜品的`制作步骤`应当完整(complete)。这意味着, 在执行完所有操作步骤后, 菜品已经被完成。 + +4. 菜品的`原材料与工具`应当完整(complete)。这意味着, 在执行操作步骤时, 没有用到`原材料与工具`中未提到的物品。 + + diff --git a/README.md b/README.md index 2549a3f..bb09ac8 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ## 如何贡献 -直接修改\添加做菜指南并提交 Pull request 即可。 +直接修改/添加做菜指南并提交 Pull request 即可。 在写新菜谱时,请复制并修改已有的模板: [示例菜](./dishes/template/示例菜/示例菜.md)。 diff --git a/tips/learn/蒸.md b/tips/learn/蒸.md index e4a13db..ea9b68d 100644 --- a/tips/learn/蒸.md +++ b/tips/learn/蒸.md @@ -11,3 +11,4 @@ #### 注意事项 * 由于热源为水蒸气,较低的蒸屉中的食物底部可能被水浸湿。可将蒸笼布放在食物底下以避免这种情况。用筷子搭个放食物的简易支架也可以。 +* 在使用蒸笼制作食品的过程中,需要注意底部区域的剩余水量,避免干锅从而造成安全问题。 diff --git a/tips/learn/高压力锅.md b/tips/learn/高压力锅.md index 25681bf..5aa65d6 100644 --- a/tips/learn/高压力锅.md +++ b/tips/learn/高压力锅.md @@ -1,11 +1,11 @@ # 蒸(米)/炖(使用电饭煲/高压锅/电压力锅) -## (6)流程 +## 流程 * 食材和水放入内胆后盒盖,**确保锅体密封**,加热。 * 切换至保温状态后,**通过排气阀将锅内蒸汽排空方可开盖** -### e.注意事项 +### 注意事项 * **水蒸气很烫,不要凑到排气阀上。** * 烹饪**流质食物**的过程中,**不要手动排气**,小心喷溅。