From aa5a7cb8c38bb2f3c84b2eb24d27304b9fa7c836 Mon Sep 17 00:00:00 2001 From: Acylation <532117255@qq.com> Date: Mon, 11 Mar 2024 16:09:00 +0800 Subject: [PATCH 1/4] Adjust issue templates --- .github/ISSUE_TEMPLATE/feature-request.yml | 2 -- .github/ISSUE_TEMPLATE/support.yml | 10 ++++++++++ 2 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/support.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 6f59e41..fb93aef 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -13,5 +13,3 @@ body: id: rationale attributes: label: Why is this needed? - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/support.yml b/.github/ISSUE_TEMPLATE/support.yml new file mode 100644 index 0000000..c64abc3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support.yml @@ -0,0 +1,10 @@ +name: Support +description: Finding support on how to use the plugin +labels: ['support'] +body: + - type: textarea + id: problem + attributes: + label: What do you need to help with? + validations: + required: true From 923f52ca619730d30215a0f6ad292c0b1d3959f1 Mon Sep 17 00:00:00 2001 From: Acylation <532117255@qq.com> Date: Mon, 11 Mar 2024 16:09:48 +0800 Subject: [PATCH 2/4] Updates contribution guide New callout syntax Revert `Discussions` --- docs/CONTRIBUTING-ZH.md | 15 ++++++--------- docs/CONTRIBUTING.md | 12 +++++------- 2 files changed, 11 insertions(+), 16 deletions(-) diff --git a/docs/CONTRIBUTING-ZH.md b/docs/CONTRIBUTING-ZH.md index 07ebc5d..52cca00 100644 --- a/docs/CONTRIBUTING-ZH.md +++ b/docs/CONTRIBUTING-ZH.md @@ -4,7 +4,7 @@ ## 设计原则 -本插件计划提供的功能需要至少满足下列条件中的一条： +本插件计划提供的功能需要满足下列条件中的至少一条： - 助力化学科研笔记，如实验记录、文献阅读笔记、论文大纲撰写等 - 帮助构建与常用化学工具紧密协作的工作流 @@ -23,6 +23,8 @@ - 本仓库提供了 issue 模板，请按照模板指引填写，以提供必要的内容 - 为您需要的功能点赞👍！投票人数更多的功能请求将被优先考虑 +同样欢迎通过 issue 咨询插件使用问题，以及展示您的使用样例！ + ## 提交 PR ### 注意事项 @@ -37,7 +39,7 @@ cd [你的工作文件夹] ``` -> **Note** +> [!Note] > 建议使用一个开发 vault 的配置文件夹作为本插件的工作文件夹。例如 `.obsidian\plugins\)`. ```cmd @@ -45,7 +47,7 @@ git clone https://github.com/Acylation/obsidian-chem.git chem cd chem ``` -> **Note** +> [!Note] > 本插件的 id 是 `chem` 而不是 `obsidian-chem` ### Install dependencies @@ -60,7 +62,7 @@ npm install npm run dev ``` -> **Note** +> [!Note] > 该命令执行后，将监听源代码的更改，并在保存更改时自动编译出一个新版的`main.js` > 下载并启用 [Hot-Reload](https://github.com/pjeby/hot-reload) 插件以获得流畅的开发体验 @@ -82,9 +84,4 @@ npm run build - 需要针对特定代码提出疑问、提供建议等，请在提交 PR 后使用 GitHub 的 code review 功能 - 您提交的PR将在审核后被合并，或被要求修改 -## 仍有疑问? - -- 如果您有任何疑问，或需要帮助，请在本仓库下的 [Discussions](https://github.com/Acylation/obsidian-chem/discussions) 栏目中发帖询问 -- 若您希望展示您的使用案例，也欢迎前往 [Discussions](https://github.com/Acylation/obsidian-chem/discussions) 栏目 - 感谢您成为本项目的一份子！🙌 diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d34ef94..6122b94 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -23,6 +23,8 @@ As an Obsidian plugin, this project adheres to the following principles: - When creating a new issue, please follow the templates to provide necessary information. - You can also vote for existing issues by adding a 👍 reaction to show your support. +You are also welcome to raise questions that you came across when using this plugin, or provide awesome showcases through issue! + ## How to submit a pull request ### General @@ -37,7 +39,7 @@ As an Obsidian plugin, this project adheres to the following principles: cd [your-working-folder] ``` -> **Note** +> [!Note] > It is recommended to use the config directory of a dev vault (e.g., .obsidian\plugins\\) as the working directory. ```cmd @@ -45,7 +47,7 @@ git clone https://github.com/Acylation/obsidian-chem.git chem cd chem ``` -> **Note** +> [!Note] > The plugin id in the manifest is `chem` rather than `obsidian-chem`. ### Install dependencies @@ -60,7 +62,7 @@ npm install npm run dev ``` -> **Note** +> [!Note] > This command will listen for changes to the source code and provide a new build when you save changes. > Download and enable the [Hot-Reload](https://github.com/pjeby/hot-reload) plugin to experience a smooth debugging workflow. @@ -82,8 +84,4 @@ npm run build - For raising questions, providing suggestions, or explaining a specific line of code, please use GitHub’s code review feature. - Please wait for a review before your pull request being merged. -## Still have questions? - -- If you still have any questions or need help with using or developing this project, please join our [Discussions](https://github.com/Acylation/obsidian-chem/discussions) right here in the repo. - Thank you for being a part of this project! 🙌 From 6e31c9d5ab36e2fa7fcb0e8e05002b097b63f42c Mon Sep 17 00:00:00 2001 From: Acylation <532117255@qq.com> Date: Mon, 11 Mar 2024 16:09:54 +0800 Subject: [PATCH 3/4] Update LICENSE --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index ab123e3..f91e984 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Chiyu Liang +Copyright (c) 2023-2024 Chiyu Liang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From 53a4844318649767b341b888244778c157c9fc1c Mon Sep 17 00:00:00 2001 From: Acylation <532117255@qq.com> Date: Mon, 11 Mar 2024 16:13:25 +0800 Subject: [PATCH 4/4] Update CONTRIBUTING-ZH.md --- docs/CONTRIBUTING-ZH.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING-ZH.md b/docs/CONTRIBUTING-ZH.md index 52cca00..e5a651a 100644 --- a/docs/CONTRIBUTING-ZH.md +++ b/docs/CONTRIBUTING-ZH.md @@ -50,13 +50,13 @@ cd chem > [!Note] > 本插件的 id 是 `chem` 而不是 `obsidian-chem` -### Install dependencies +### 安装依赖 ```cmd npm install ``` -### Developing +### 进行开发 ```cmd npm run dev