Skip to content

Commit 1a52827

Browse files
authored
Update docs (#62)
* Adjust issue templates * Updates contribution guide New callout syntax Revert `Discussions` * Update LICENSE
1 parent 9aaaa40 commit 1a52827

File tree

5 files changed

+22
-19
lines changed

5 files changed

+22
-19
lines changed

.github/ISSUE_TEMPLATE/feature-request.yml

-2
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,3 @@ body:
1313
id: rationale
1414
attributes:
1515
label: Why is this needed?
16-
validations:
17-
required: true

.github/ISSUE_TEMPLATE/support.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Support
2+
description: Finding support on how to use the plugin
3+
labels: ['support']
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: What do you need to help with?
9+
validations:
10+
required: true

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Chiyu Liang
3+
Copyright (c) 2023-2024 Chiyu Liang
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/CONTRIBUTING-ZH.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## 设计原则
66

7-
本插件计划提供的功能需要至少满足下列条件中的一条
7+
本插件计划提供的功能需要满足下列条件中的至少一条
88

99
- 助力化学科研笔记,如实验记录、文献阅读笔记、论文大纲撰写等
1010
- 帮助构建与常用化学工具紧密协作的工作流
@@ -23,6 +23,8 @@
2323
- 本仓库提供了 issue 模板,请按照模板指引填写,以提供必要的内容
2424
- 为您需要的功能点赞👍!投票人数更多的功能请求将被优先考虑
2525

26+
同样欢迎通过 issue 咨询插件使用问题,以及展示您的使用样例!
27+
2628
## 提交 PR
2729

2830
### 注意事项
@@ -37,15 +39,15 @@
3739
cd [你的工作文件夹]
3840
```
3941

40-
> **Note**
42+
> [!Note]
4143
> 建议使用一个开发 vault 的配置文件夹作为本插件的工作文件夹。例如 `.obsidian\plugins\)`.
4244
4345
```cmd
4446
git clone https://github.com/Acylation/obsidian-chem.git chem
4547
cd chem
4648
```
4749

48-
> **Note**
50+
> [!Note]
4951
> 本插件的 id 是 `chem` 而不是 `obsidian-chem`
5052
5153
### Install dependencies
@@ -60,7 +62,7 @@ npm install
6062
npm run dev
6163
```
6264

63-
> **Note**
65+
> [!Note]
6466
> 该命令执行后,将监听源代码的更改,并在保存更改时自动编译出一个新版的`main.js`
6567
> 下载并启用 [Hot-Reload](https://github.com/pjeby/hot-reload) 插件以获得流畅的开发体验
6668
@@ -82,9 +84,4 @@ npm run build
8284
- 需要针对特定代码提出疑问、提供建议等,请在提交 PR 后使用 GitHub 的 code review 功能
8385
- 您提交的PR将在审核后被合并,或被要求修改
8486

85-
## 仍有疑问?
86-
87-
- 如果您有任何疑问,或需要帮助,请在本仓库下的 [Discussions](https://github.com/Acylation/obsidian-chem/discussions) 栏目中发帖询问
88-
- 若您希望展示您的使用案例,也欢迎前往 [Discussions](https://github.com/Acylation/obsidian-chem/discussions) 栏目
89-
9087
感谢您成为本项目的一份子!🙌

docs/CONTRIBUTING.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ As an Obsidian plugin, this project adheres to the following principles:
2323
- When creating a new issue, please follow the templates to provide necessary information.
2424
- You can also vote for existing issues by adding a 👍 reaction to show your support.
2525

26+
You are also welcome to raise questions that you came across when using this plugin, or provide awesome showcases through issue!
27+
2628
## How to submit a pull request
2729

2830
### General
@@ -37,15 +39,15 @@ As an Obsidian plugin, this project adheres to the following principles:
3739
cd [your-working-folder]
3840
```
3941

40-
> **Note**
42+
> [!Note]
4143
> It is recommended to use the config directory of a dev vault (e.g., .obsidian\plugins\\) as the working directory.
4244
4345
```cmd
4446
git clone https://github.com/Acylation/obsidian-chem.git chem
4547
cd chem
4648
```
4749

48-
> **Note**
50+
> [!Note]
4951
> The plugin id in the manifest is `chem` rather than `obsidian-chem`.
5052
5153
### Install dependencies
@@ -60,7 +62,7 @@ npm install
6062
npm run dev
6163
```
6264

63-
> **Note**
65+
> [!Note]
6466
> This command will listen for changes to the source code and provide a new build when you save changes.
6567
> Download and enable the [Hot-Reload](https://github.com/pjeby/hot-reload) plugin to experience a smooth debugging workflow.
6668
@@ -82,8 +84,4 @@ npm run build
8284
- For raising questions, providing suggestions, or explaining a specific line of code, please use GitHub’s code review feature.
8385
- Please wait for a review before your pull request being merged.
8486

85-
## Still have questions?
86-
87-
- 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.
88-
8987
Thank you for being a part of this project! 🙌

0 commit comments

Comments
 (0)