From 00000000e881f96a96d37f4fd51b4152bfc7045f Mon Sep 17 00:00:00 2001 From: Recolic Keghart Date: Sat, 19 Feb 2022 18:58:16 +0800 Subject: [PATCH 1/8] Enhance contributing guide. "& --- .github/workflows/ci.yml | 2 +- CONTRIBUTING.md | 69 ++++++++++++++++++++++++++++++++++++++++ README.md | 11 +------ 3 files changed, 71 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md 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 new file mode 100644 index 000000000..5fc4af0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# CONTRIBUTING Guide + +## 为什么会有这个项目 (Motivation) + +Add some motivation here. @Anduin + +Recolic的个人观点: 菜谱的目的是复现一道菜。在做菜的过程中，菜会受厨师的经验、主观判断、生活经历而改变。 +但是为了达到`复现一道菜`的目的，菜谱必须是客观的，也就意味着菜谱本身不应受厨师的经验、主观判断而改变。 +菜的创作者(厨师)、菜的记录者(菜谱)、菜的生产者(饥饿的程序员、炒菜机器人)应当是三个不同的角色。如果生产者偶尔心情愉悦，可以兼职为创作者。但记录者是为生产者服务的。 + +## 新内容注意事项 + +此仓库中的菜谱需要满足以下规范，不符合规范的菜谱将不会被合并到代码库中。 + +1. 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。 + +`原材料与工具`应列出本菜品需要的除`假想已准备好的物品`外的所有原材料与厨具。 +`计算`应定量列出本菜品所需的原材料的量。（无论与人数是否相关） +`操作`应说明菜品的制作步骤。 + +2. 菜品的制作步骤应当明确(无歧义,non-ambiguous)，并尽可能准确(accurate)。有歧义(ambiguous)的描述是不可接受的，而不准确(inaccurate)或不精确(imprecise)的描述是可以接受的。 + +> 不准确的菜谱会导致菜品口味有少许偏差，不明确的菜谱会导致做菜人的心态有明显不安。 + +举例：有歧义的描述 + +``` +# 解释：此处对于盐量的描述是有歧义的。 +# 因为对于某个数量的盐，用户无法得出确定的客观结论：此数量是否属于"少量"。 +加入少量盐 + +加入几滴耗油 +将锅加热至八分热 +撒上少许葱花 +煮至鸡肉断生 +``` + +举例：无歧义的描述 + +``` +# 解释：此处对于锅的温度的描述是不准确的（可能是200摄氏度左右的任何温度），但这个描述是无歧义的。 +# 因为对于锅的某个状态，用户可以进行水滴测试，并得出确定的客观结论：此状态要么符合要求，要么不符合要求。 +加热锅，直至"滴入几滴水时，水珠能够在锅上迅速滚动而不吸附" +加热锅，直至观察到莱顿弗罗斯特现象 + +加入5ml酱油 +等到水沸腾后 +继续煮，直到汤汁剩下二分之一 +煎至表面呈金黄色 +继续翻炒两分钟 + +# 食材所可能粘附的蛋液的量是确定的 +裹上蛋液 + +# 在'计算'中已提及将用到葱花的量 +撒上葱花 +``` + +考虑到现实因素，对于某些在家庭厨房中确实难以明确描述的因素，作为特例，允许使用以下词汇。 + +``` +# 在描述燃气灶火焰强度时 +文火, 小火, 中火, 大火 等 +# 在描述颜色时 +金黄色 等 +``` + +3. 菜品的制作步骤应当完整(complete)。 + diff --git a/README.md b/README.md index 9e0c9a7..c09a895 100644 --- a/README.md +++ b/README.md @@ -98,14 +98,5 @@ ## 如何贡献 -直接修改这部分做菜指南并提交 Pull request 即可。 +直接进行修改并提交 Pull request 即可。为了保证您的PR被及时合并，建议阅读[贡献指南](./CONTRIBUTING.md)。 -补充菜谱时，针对一道菜，必须给出其`必需原材料`，`原材料用量计算公式`。 - -必须清晰准确的描述过程。在描述过程时不得加入上文或原材料中未提及的食材。凡是需要等待的步骤必须给出`等待时间计算公式`或`结束一个步骤的判断标准`。 - -使用 markdown 描述这道菜的`必需原材料`、`计算公式`、`操作步骤`、`附加内容`。如果有参考资料，请一并给出。 - -不允许使用不精准描述的词汇，例如：`适量`、`少量`、`中量`、`适当`。 - -不完整或不符合上述规范的菜谱将不会被允许合并到代码库中。 From df462abbdccec0464aebc5fb6fe232cdd218c59b Mon Sep 17 00:00:00 2001 From: Recolic Date: Sun, 20 Feb 2022 16:39:09 +0800 Subject: [PATCH 2/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5fc4af0..034caf9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Add some motivation here. @Anduin Recolic的个人观点: 菜谱的目的是复现一道菜。在做菜的过程中，菜会受厨师的经验、主观判断、生活经历而改变。 但是为了达到`复现一道菜`的目的，菜谱必须是客观的，也就意味着菜谱本身不应受厨师的经验、主观判断而改变。 -菜的创作者(厨师)、菜的记录者(菜谱)、菜的生产者(饥饿的程序员、炒菜机器人)应当是三个不同的角色。如果生产者偶尔心情愉悦，可以兼职为创作者。但记录者是为生产者服务的。 +菜的创作者(厨师)、菜的记录者(菜谱)、菜的生产者(饥饿的程序员、炒菜机器人)应当是三个不同的角色。如果生产者偶尔心情愉悦，可以兼职为创作者。记录者是为生产者服务的。 ## 新内容注意事项 @@ -56,13 +56,15 @@ Recolic的个人观点: 菜谱的目的是复现一道菜。在做菜的过程 撒上葱花 ``` -考虑到现实因素，对于某些在家庭厨房中确实难以明确描述的因素，作为特例，允许使用以下词汇。 +考虑到现实因素，对于某些在家庭厨房中确实难以明确描述的因素，可以作为特例排除。例如 ``` # 在描述燃气灶火焰强度时 文火, 小火, 中火, 大火 等 # 在描述颜色时 金黄色 等 +# 在描述硬度时 +变软 变硬 ``` 3. 菜品的制作步骤应当完整(complete)。 From 1d11c1360a27dd6f3e0ebd561968284590b39ac8 Mon Sep 17 00:00:00 2001 From: Recolic Keghart Date: Sun, 20 Feb 2022 16:57:13 +0800 Subject: [PATCH 3/8] unnecessary material/tools allowed --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09ec66d..fb76d6d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,6 +83,6 @@ 3. 菜品的`制作步骤`应当完整(complete)。这意味着, 在执行完所有操作步骤后, 菜品已经被完成。 -4. 菜品的`原材料与工具`应当完整(complete)且必要。这意味着, 在执行完所有操作步骤后, 没有原材料被遗漏不用。在执行操作步骤时, 没有用到`原材料与工具`中未提到的物品。 +4. 菜品的`原材料与工具`应当完整(complete)。这意味着, 在执行操作步骤时, 没有用到`原材料与工具`中未提到的物品。 From c35b18f1353434430bfe79a9a2793894ea244490 Mon Sep 17 00:00:00 2001 From: Recolic Keghart Date: Sun, 20 Feb 2022 16:59:52 +0800 Subject: [PATCH 4/8] fix --- CONTRIBUTING.md | 16 +--------------- README.md | 2 +- 2 files changed, 2 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb76d6d..7fcf483 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,23 +8,9 @@ 记得在提交 Pull Request 前同样更新一下 Readme.md 里的引用。 -## 为什么会有这个项目 (Motivation) - -- Anduin的Motivation - -最近在家隔离，出不了门。只能宅在家做饭了。作为程序员，我偶尔在网上找找菜谱和做法。但是这些菜谱往往写法千奇百怪，经常中间莫名出来一些材料。对于习惯了形式语言的程序员来说极其不友好。 - -所以，我计划自己搜寻菜谱和并结合实际做菜的经验，准备用更清晰精准的描述来整理常见菜的做法，以方便程序员在家做饭。 - -- Recolic的个人观点 - -菜谱的目的是复现一道菜。在做菜的过程中，菜会受厨师的经验、主观判断、生活经历而改变。 -但是为了达到`复现一道菜`的目的，菜谱必须是客观的，也就意味着菜谱本身不应受厨师的经验、主观判断而改变。 -菜的创作者(厨师)、菜的记录者(菜谱)、菜的生产者(饥饿的程序员、炒菜机器人)应当是三个不同的角色。如果生产者偶尔心情愉悦，可以兼职为创作者。记录者是为生产者服务的。 - ## 内容规范 -本项目的Motivation要求菜谱满足以下规范，不符合规范的菜谱将不会被合并到代码库中。如果以下内容不易理解, 不必担心. 仓库管理者会在你的PR中提出建议, 并协助修改。 +本项目的Motivation要求菜谱满足以下规范，不符合规范的菜谱将不会被合并到代码库中。**对于绝大多数菜谱提交者, 无需阅读此内容规范. 仓库管理者会在你的PR中提出建议, 并协助修改。** 1. 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。 diff --git a/README.md b/README.md index b882cdb..baba158 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ 直接修改/添加做菜指南并提交 Pull request 即可。 -在写新菜谱时，请复制并修改已有的模板: [示例菜](./dishes/template/示例菜/示例菜.md)。如果仍有疑问, 可参考[贡献指南](./CONTRIBUTING.md)。 +在写新菜谱时，请复制并修改已有的模板: [示例菜](./dishes/template/示例菜/示例菜.md)。 记得在提交 Pull Request 前同样更新一下 Readme.md 里的引用。 From c8b7b2ceac41ff1690a8e0df0d7327c5c9c9ab37 Mon Sep 17 00:00:00 2001 From: Recolic Keghart Date: Sun, 20 Feb 2022 17:07:54 +0800 Subject: [PATCH 5/8] fix --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fcf483..bed0ded 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,9 @@ ## 内容规范 -本项目的Motivation要求菜谱满足以下规范，不符合规范的菜谱将不会被合并到代码库中。**对于绝大多数菜谱提交者, 无需阅读此内容规范. 仓库管理者会在你的PR中提出建议, 并协助修改。** +**菜谱提交者无需阅读此内容规范。以下内容已经以简明易懂的方式包含在示例模板中。项目的维护者会在你的PR中提出建议, 并协助修改。** + +本项目的Motivation要求菜谱满足以下规范，不符合规范的菜谱将不会被合并到代码库中。项目的维护者维护此文档, 作为正式的标准与共识。 1. 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。 From d94c476ce35e1b22c24441e498056374ae77feb2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sun, 20 Feb 2022 09:25:58 +0000 Subject: [PATCH 6/8] [ci skip] Automatic textlint fixes --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bed0ded..3282004 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ **菜谱提交者无需阅读此内容规范。以下内容已经以简明易懂的方式包含在示例模板中。项目的维护者会在你的PR中提出建议, 并协助修改。** -本项目的Motivation要求菜谱满足以下规范，不符合规范的菜谱将不会被合并到代码库中。项目的维护者维护此文档, 作为正式的标准与共识。 +本项目的 Motivation 要求菜谱满足以下规范，不符合规范的菜谱将不会被合并到代码库中。项目的维护者维护此文档, 作为正式的标准与共识。 1. 每一道菜谱至少应包含`原材料与工具`, `计算`, `操作`三部分内容。 From 49120249f40941dc334010dc5331acc180f5baaf Mon Sep 17 00:00:00 2001 From: Anduin Xue Date: Sun, 20 Feb 2022 17:29:02 +0800 Subject: [PATCH 7/8] =?UTF-8?q?Update=20=E9=AB=98=E5=8E=8B=E5=8A=9B?= =?UTF-8?q?=E9=94=85.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tips/learn/高压力锅.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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.注意事项 +### 注意事项 * **水蒸气很烫，不要凑到排气阀上。** * 烹饪**流质食物**的过程中，**不要手动排气**，小心喷溅。 From 9fd6f30b264b6077093eaf6e08f2ec112f0d2e3f Mon Sep 17 00:00:00 2001 From: Waki <2206602594@qq.com> Date: Sun, 20 Feb 2022 19:17:14 +0800 Subject: [PATCH 8/8] =?UTF-8?q?Update=20=E8=92=B8.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 增加干锅注意事项 --- tips/learn/蒸.md | 1 + 1 file changed, 1 insertion(+) 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 @@ #### 注意事项 * 由于热源为水蒸气，较低的蒸屉中的食物底部可能被水浸湿。可将蒸笼布放在食物底下以避免这种情况。用筷子搭个放食物的简易支架也可以。 +* 在使用蒸笼制作食品的过程中，需要注意底部区域的剩余水量，避免干锅从而造成安全问题。