Skip to content

Commit f69a142

Browse files
committed
docs: modify fluent-editor to tiny-editor (#213)
1 parent b5847f6 commit f69a142

File tree

15 files changed

+73
-72
lines changed

15 files changed

+73
-72
lines changed

.all-contributorsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,6 @@
6767
"skipCi": true,
6868
"repoType": "github",
6969
"repoHost": "https://github.com",
70-
"projectName": "fluent-editor",
70+
"projectName": "tiny-editor",
7171
"projectOwner": "opentiny"
7272
}

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ body:
88
value: |
99
Please fill out the following carefully in order to better fix the problem.
1010
- type: input
11-
id: fluent-editor-version
11+
id: tiny-editor-version
1212
attributes:
1313
label: Version
1414
description: |

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: true
22
contact_links:
33
- name: Questions or need help
4-
url: https://github.com/opentiny/fluent-editor/discussions
5-
about: Add this WeChat(opentiny-official, note on "fluent-editor"), we will invite you to the WeChat discussion group later.
4+
url: https://github.com/opentiny/tiny-editor/discussions
5+
about: Add this WeChat(opentiny-official, note on "tiny-editor"), we will invite you to the WeChat discussion group later.

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22

33
We are delighted that you are interested in contributing to the TinyEditor open-source project. There are many ways to contribute, and you can choose one or more based on your strengths and interests:
44

5-
- Report [new issues](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+)
6-
- Provide more detailed information for [existing issues](https://github.com/opentiny/fluent-editor/labels/bug), such as additional screenshots, detailed reproduction steps, or providing a minimal reproducible demo link
5+
- Report [new issues](https://github.com/opentiny/tiny-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+)
6+
- Provide more detailed information for [existing issues](https://github.com/opentiny/tiny-editor/labels/bug), such as additional screenshots, detailed reproduction steps, or providing a minimal reproducible demo link
77
- Submit Pull requests to fix typos in the documentation or to make the documentation clearer and more comprehensive
88
- Add the official assistant WeChat: opentiny-official (note: TinyEditor), join the technical discussion group
99

1010
Once you have used TinyEditor rich text and participated in several of the above forms of contributions, and have become familiar with TinyEditor, you can try more challenging tasks, such as:
1111

12-
- Fixing bugs, starting with [good first issue](https://github.com/opentiny/fluent-editor/labels/good%20first%20issue)
12+
- Fixing bugs, starting with [good first issue](https://github.com/opentiny/tiny-editor/labels/good%20first%20issue)
1313
- Implementing new features
1414
- Improving unit tests
1515
- Translating documentation
1616
- Participating in code reviews
1717

1818
## Submitting Issues
1919

20-
If you encounter problems while using TinyEditor, we welcome you to submit an Issue. Before submitting an Issue, please read the relevant [official documentation](https://opentiny.github.io/fluent-editor) to confirm whether it is a defect or a feature that has not yet been implemented.
20+
If you encounter problems while using TinyEditor, we welcome you to submit an Issue. Before submitting an Issue, please read the relevant [official documentation](https://opentiny.github.io/tiny-editor) to confirm whether it is a defect or a feature that has not yet been implemented.
2121

22-
If it is a defect, create a new Issue using the [Bug report](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+) template. Example title: `After setting and saving the background color of table cells in the table module, the background color is lost when rendering the cells next time`.
22+
If it is a defect, create a new Issue using the [Bug report](https://github.com/opentiny/tiny-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+) template. Example title: `After setting and saving the background color of table cells in the table module, the background color is lost when rendering the cells next time`.
2323

2424
The Issue for reporting defects mainly requires the following information:
2525

2626
- The version number of `@opentiny/fluent-editor`
2727
- The manifestation of the defect, which can be supplemented with screenshots, and if there is an error, the error message can be pasted
2828
- The reproduction steps of the defect, preferably providing a minimal reproducible demo link
2929

30-
If it is a new feature, choose the [Feature request](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%E2%9C%A8+feature&projects=&template=feature-request.yml&title=%E2%9C%A8+%5BFeature%5D%3A+) template. Example title: `I hope to add the functionality of a format painter`.
30+
If it is a new feature, choose the [Feature request](https://github.com/opentiny/tiny-editor/issues/new?assignees=&labels=%E2%9C%A8+feature&projects=&template=feature-request.yml&title=%E2%9C%A8+%5BFeature%5D%3A+) template. Example title: `I hope to add the functionality of a format painter`.
3131

3232
The Issue for new features mainly requires the following information:
3333

@@ -36,7 +36,7 @@ The Issue for new features mainly requires the following information:
3636

3737
## Submitting PRs
3838

39-
Before submitting a PR, please ensure that the content you submit is in line with the overall planning of TinyEditor. Generally, Issues already marked as [bug](https://github.com/opentiny/fluent-editor/labels/bug) encourage submitting PRs. If you are not sure, you can create a [Discussion](https://github.com/opentiny/fluent-editor/discussions) for discussion.
39+
Before submitting a PR, please ensure that the content you submit is in line with the overall planning of TinyEditor. Generally, Issues already marked as [bug](https://github.com/opentiny/tiny-editor/labels/bug) encourage submitting PRs. If you are not sure, you can create a [Discussion](https://github.com/opentiny/tiny-editor/discussions) for discussion.
4040

4141
### Pull Request Standards
4242

@@ -71,20 +71,20 @@ The PR description uses a template and requires filling in the relevant PR infor
7171

7272
### Local Startup Steps
7373

74-
- Click the Fork button at the top right of the [TinyEditor](https://github.com/opentiny/fluent-editor) code repository to Fork the upstream repository to your personal repository
74+
- Click the Fork button at the top right of the [TinyEditor](https://github.com/opentiny/tiny-editor) code repository to Fork the upstream repository to your personal repository
7575
- Clone your personal repository to the local
7676
- Associate the upstream repository to synchronize the latest code from the upstream repository
7777
- Run `pnpm i` in the root directory of TinyEditor to install dependencies
7878
- Run `pnpm dev` to start the rich text website
79-
- Open the browser to visit: [http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
79+
- Open the browser to visit: [http://localhost:5173/tiny-editor/](http://localhost:5173/tiny-editor/)
8080

8181
```shell
8282
# username is the username, please replace it before execution
83-
git clone git@github.com:username/fluent-editor.git
84-
cd fluent-editor
83+
git clone git@github.com:username/tiny-editor.git
84+
cd tiny-editor
8585

8686
# Associate the upstream repository
87-
git remote add upstream git@github.com:opentiny/fluent-editor.git
87+
git remote add upstream git@github.com:opentiny/tiny-editor.git
8888

8989
# Install dependencies
9090
pnpm i
@@ -95,13 +95,13 @@ pnpm dev
9595

9696
### Steps for Submitting PRs
9797

98-
- Please ensure that you have completed the steps in the local startup and can access: [http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
98+
- Please ensure that you have completed the steps in the local startup and can access: [http://localhost:5173/tiny-editor/](http://localhost:5173/tiny-editor/)
9999
- Synchronize the latest code from the upstream repository main branch: git pull upstream main
100100
- Create a new branch from the upstream repository main branch `git checkout -b username/feature1 upstream/main`, the branch name is recommended to be `username/feat-xxx` / `username/fix-xxx`
101101
- Local coding
102102
- Follow the [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) standard for submission, PRs that do not conform to the submission standard will not be merged
103103
- Submit to the remote repository: git push origin branchName
104-
- Open the [Pull requests](https://github.com/opentiny/fluent-editor/pulls) link of the TinyEditor code repository, click the New pull request button to submit PR
104+
- Open the [Pull requests](https://github.com/opentiny/tiny-editor/pulls) link of the TinyEditor code repository, click the New pull request button to submit PR
105105
- Supplement the relevant information according to the PR template, including PR checklist, PR type, associated Issue number, whether it is a destructive change
106106
- The project Committer conducts Code Review and provides feedback
107107
- The PR author adjusts the code according to the feedback, please note that after a branch has initiated a PR, subsequent commits will be synchronized automatically, no need to resubmit PR

CONTRIBUTING.zh-CN.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22

33
很高兴你有意愿参与 TinyEditor 开源项目的贡献,参与贡献的形式有很多种,你可以根据自己的特长和兴趣选择其中的一个或多个:
44

5-
- 报告[新缺陷](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+)
6-
-[已有缺陷](https://github.com/opentiny/fluent-editor/labels/bug)提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现 demo 链接等
5+
- 报告[新缺陷](https://github.com/opentiny/tiny-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+)
6+
-[已有缺陷](https://github.com/opentiny/tiny-editor/labels/bug)提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现 demo 链接等
77
- 提交 Pull requests 修复文档中的错别字或让文档更清晰和完善
88
- 添加官方小助手微信 opentiny-official(备注:TinyEditor),加入技术交流群参与讨论
99

1010
当你亲自使用 TinyEditor 富文本,并参与多次以上形式的贡献,对 TinyEditor 逐渐熟悉之后,可以尝试做一些更有挑战的事情,比如:
1111

12-
- 修复缺陷,可以先从 [Good-first issue](https://github.com/opentiny/fluent-editor/labels/good%20first%20issue) 开始
12+
- 修复缺陷,可以先从 [Good-first issue](https://github.com/opentiny/tiny-editor/labels/good%20first%20issue) 开始
1313
- 实现新特性
1414
- 完善单元测试
1515
- 翻译文档
1616
- 参与代码检视
1717

1818
## 提交 Issue
1919

20-
如果你在使用 TinyEditor 富文本过程中遇到问题,欢迎给我们提交 Issue,提交 Issue 之前,请先仔细阅读相关的[官方文档](https://opentiny.github.io/fluent-editor),确认这是一个缺陷还是尚未实现的功能。
20+
如果你在使用 TinyEditor 富文本过程中遇到问题,欢迎给我们提交 Issue,提交 Issue 之前,请先仔细阅读相关的[官方文档](https://opentiny.github.io/tiny-editor),确认这是一个缺陷还是尚未实现的功能。
2121

22-
如果是一个缺陷,创建新 Issue 时选择 [Bug report](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+) 模板,标题示例:`在表格模块中,设置单元格背景色并保存之后,下次渲染单元格背景色丢失`
22+
如果是一个缺陷,创建新 Issue 时选择 [Bug report](https://github.com/opentiny/tiny-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+) 模板,标题示例:`在表格模块中,设置单元格背景色并保存之后,下次渲染单元格背景色丢失`
2323

2424
报告缺陷的 Issue 主要需要填写以下信息:
2525

2626
- `@opentiny/fluent-editor` 的版本号
2727
- 缺陷的表现,可截图辅助说明,如果有报错可贴上报错信息
2828
- 缺陷的复现步骤,最好能提供一个最小可复现 demo 链接
2929

30-
如果是一个新特性,则选择 [Feature request](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%E2%9C%A8+feature&projects=&template=feature-request.yml&title=%E2%9C%A8+%5BFeature%5D%3A+) 模板,标题示例:`希望增加格式刷的功能`
30+
如果是一个新特性,则选择 [Feature request](https://github.com/opentiny/tiny-editor/issues/new?assignees=&labels=%E2%9C%A8+feature&projects=&template=feature-request.yml&title=%E2%9C%A8+%5BFeature%5D%3A+) 模板,标题示例:`希望增加格式刷的功能`
3131

3232
新特性的 Issue 主要需要填写以下信息:
3333

@@ -36,7 +36,7 @@
3636

3737
## 提交 PR
3838

39-
提交 PR 之前,请先确保你提交的内容是符合 TinyEditor 整体规划的,一般已经标记为 [bug](https://github.com/opentiny/fluent-editor/labels/bug) 的 Issue 是鼓励提交 PR 的,如果你不是很确定,可以创建一个 [Discussion](https://github.com/opentiny/fluent-editor/discussions) 进行讨论。
39+
提交 PR 之前,请先确保你提交的内容是符合 TinyEditor 整体规划的,一般已经标记为 [bug](https://github.com/opentiny/tiny-editor/labels/bug) 的 Issue 是鼓励提交 PR 的,如果你不是很确定,可以创建一个 [Discussion](https://github.com/opentiny/tiny-editor/discussions) 进行讨论。
4040

4141
### Pull Request 规范
4242

@@ -71,20 +71,20 @@ PR 描述使用了模板,需要按照模板填写 PR 相关信息,主要包
7171

7272
### 本地启动步骤
7373

74-
- 点击 [TinyEditor](https://github.com/opentiny/fluent-editor) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库
74+
- 点击 [TinyEditor](https://github.com/opentiny/tiny-editor) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库
7575
- Clone 个人仓库到本地
7676
- 关联上游仓库,方便同步上游仓库最新代码
7777
- 在 TinyEditor 根目录下运行 `pnpm i`,安装依赖
7878
- 运行 `pnpm dev`,启动富文本网站
79-
- 打开浏览器访问:[http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
79+
- 打开浏览器访问:[http://localhost:5173/tiny-editor/](http://localhost:5173/tiny-editor/)
8080

8181
```shell
8282
# username 为用户名,执行前请替换
83-
git clone git@github.com:username/fluent-editor.git
84-
cd fluent-editor
83+
git clone git@github.com:username/tiny-editor.git
84+
cd tiny-editor
8585

8686
# 关联上游仓库
87-
git remote add upstream git@github.com:opentiny/fluent-editor.git
87+
git remote add upstream git@github.com:opentiny/tiny-editor.git
8888

8989
# 安装依赖
9090
pnpm i
@@ -95,13 +95,13 @@ pnpm dev
9595

9696
### 提交 PR 的步骤
9797

98-
- 请确保你已经完成本地启动中的步骤,并能正常访问:[http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
98+
- 请确保你已经完成本地启动中的步骤,并能正常访问:[http://localhost:5173/tiny-editor/](http://localhost:5173/tiny-editor/)
9999
- 同步上游仓库 main 分支最新代码:git pull upstream main
100100
- 从上游仓库 main 分支创建新分支 `git checkout -b username/feature1 upstream/main`,分支名字建议为 `username/feat-xxx` / `username/fix-xxx`
101101
- 本地编码
102102
- 遵循 [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范进行提交,不符合提交规范的 PR 将不会被合并
103103
- 提交到远程仓库:git push origin branchName
104-
- 打开 TinyEditor 代码仓库的 [Pull requests](https://github.com/opentiny/fluent-editor/pulls) 链接,点击 New pull request 按钮提交 PR
104+
- 打开 TinyEditor 代码仓库的 [Pull requests](https://github.com/opentiny/tiny-editor/pulls) 链接,点击 New pull request 按钮提交 PR
105105
- 按照 PR 模板补充相关信息,包括 PR 自检项、PR 类型、关联的 Issue 编号、是否是破坏性变更
106106
- 项目 Committer 进行 Code Review,并提出意见
107107
- PR 作者根据意见调整代码,请注意一个分支发起了 PR 后,后续的 commit 会自动同步,无需重新提交 PR

0 commit comments

Comments
 (0)