Skip to content

Commit

Permalink
docs: modify fluent-editor to tiny-editor
Browse files Browse the repository at this point in the history
  • Loading branch information
kagol committed Jan 17, 2025
1 parent b5847f6 commit 3cfa8e3
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions or need help
url: https://github.com/opentiny/fluent-editor/discussions
url: https://github.com/opentiny/tiny-editor/discussions
about: Add this WeChat(opentiny-official, note on "fluent-editor"), we will invite you to the WeChat discussion group later.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

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:

- 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+)
- 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
- 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+)
- 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
- Submit Pull requests to fix typos in the documentation or to make the documentation clearer and more comprehensive
- Add the official assistant WeChat: opentiny-official (note: TinyEditor), join the technical discussion group

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:

- Fixing bugs, starting with [good first issue](https://github.com/opentiny/fluent-editor/labels/good%20first%20issue)
- Fixing bugs, starting with [good first issue](https://github.com/opentiny/tiny-editor/labels/good%20first%20issue)
- Implementing new features
- Improving unit tests
- Translating documentation
Expand All @@ -19,15 +19,15 @@ Once you have used TinyEditor rich text and participated in several of the above

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.

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`.
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`.

The Issue for reporting defects mainly requires the following information:

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

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`.
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`.

The Issue for new features mainly requires the following information:

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

## Submitting PRs

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.
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.

### Pull Request Standards

Expand Down Expand Up @@ -71,7 +71,7 @@ The PR description uses a template and requires filling in the relevant PR infor

### Local Startup Steps

- 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
- 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
- Clone your personal repository to the local
- Associate the upstream repository to synchronize the latest code from the upstream repository
- Run `pnpm i` in the root directory of TinyEditor to install dependencies
Expand Down Expand Up @@ -101,7 +101,7 @@ pnpm dev
- Local coding
- 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
- Submit to the remote repository: git push origin branchName
- 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
- 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
- Supplement the relevant information according to the PR template, including PR checklist, PR type, associated Issue number, whether it is a destructive change
- The project Committer conducts Code Review and provides feedback
- 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
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

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

- 报告[新缺陷](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+)
-[已有缺陷](https://github.com/opentiny/fluent-editor/labels/bug)提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现 demo 链接等
- 报告[新缺陷](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+)
-[已有缺陷](https://github.com/opentiny/tiny-editor/labels/bug)提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现 demo 链接等
- 提交 Pull requests 修复文档中的错别字或让文档更清晰和完善
- 添加官方小助手微信 opentiny-official(备注:TinyEditor),加入技术交流群参与讨论

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

- 修复缺陷,可以先从 [Good-first issue](https://github.com/opentiny/fluent-editor/labels/good%20first%20issue) 开始
- 修复缺陷,可以先从 [Good-first issue](https://github.com/opentiny/tiny-editor/labels/good%20first%20issue) 开始
- 实现新特性
- 完善单元测试
- 翻译文档
Expand All @@ -19,15 +19,15 @@

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

如果是一个缺陷,创建新 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+) 模板,标题示例:`在表格模块中,设置单元格背景色并保存之后,下次渲染单元格背景色丢失`
如果是一个缺陷,创建新 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+) 模板,标题示例:`在表格模块中,设置单元格背景色并保存之后,下次渲染单元格背景色丢失`

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

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

如果是一个新特性,则选择 [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+) 模板,标题示例:`希望增加格式刷的功能`
如果是一个新特性,则选择 [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+) 模板,标题示例:`希望增加格式刷的功能`

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

Expand All @@ -36,7 +36,7 @@

## 提交 PR

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

### Pull Request 规范

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

### 本地启动步骤

- 点击 [TinyEditor](https://github.com/opentiny/fluent-editor) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库
- 点击 [TinyEditor](https://github.com/opentiny/tiny-editor) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库
- Clone 个人仓库到本地
- 关联上游仓库,方便同步上游仓库最新代码
- 在 TinyEditor 根目录下运行 `pnpm i`,安装依赖
Expand Down Expand Up @@ -101,7 +101,7 @@ pnpm dev
- 本地编码
- 遵循 [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范进行提交,不符合提交规范的 PR 将不会被合并
- 提交到远程仓库:git push origin branchName
- 打开 TinyEditor 代码仓库的 [Pull requests](https://github.com/opentiny/fluent-editor/pulls) 链接,点击 New pull request 按钮提交 PR
- 打开 TinyEditor 代码仓库的 [Pull requests](https://github.com/opentiny/tiny-editor/pulls) 链接,点击 New pull request 按钮提交 PR
- 按照 PR 模板补充相关信息,包括 PR 自检项、PR 类型、关联的 Issue 编号、是否是破坏性变更
- 项目 Committer 进行 Code Review,并提出意见
- PR 作者根据意见调整代码,请注意一个分支发起了 PR 后,后续的 commit 会自动同步,无需重新提交 PR
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/zzxming"><img src="https://avatars.githubusercontent.com/u/74341337?v=4?s=100" width="100px;" alt="zzxming"/><br /><sub><b>zzxming</b></sub></a><br /><a href="https://github.com/opentiny/fluent-editor/commits?author=zzxming" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Janson1012"><img src="https://avatars.githubusercontent.com/u/60996238?v=4?s=100" width="100px;" alt="Janson1012"/><br /><sub><b>Janson1012</b></sub></a><br /><a href="https://github.com/opentiny/fluent-editor/commits?author=Janson1012" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://kagol.github.io/blogs"><img src="https://avatars.githubusercontent.com/u/9566362?v=4?s=100" width="100px;" alt="Kagol"/><br /><sub><b>Kagol</b></sub></a><br /><a href="https://github.com/opentiny/fluent-editor/commits?author=kagol" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/kiss-keray"><img src="https://avatars.githubusercontent.com/u/24504763?v=4?s=100" width="100px;" alt="keray"/><br /><sub><b>keray</b></sub></a><br /><a href="https://github.com/opentiny/fluent-editor/commits?author=kiss-keray" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/qwangry"><img src="https://avatars.githubusercontent.com/u/58112936?v=4?s=100" width="100px;" alt="qwangry"/><br /><sub><b>qwangry</b></sub></a><br /><a href="https://github.com/opentiny/fluent-editor/commits?author=qwangry" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jany55555"><img src="https://avatars.githubusercontent.com/u/173228510?v=4?s=100" width="100px;" alt="jany55555"/><br /><sub><b>jany55555</b></sub></a><br /><a href="https://github.com/opentiny/fluent-editor/commits?author=jany55555" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/zzxming"><img src="https://avatars.githubusercontent.com/u/74341337?v=4?s=100" width="100px;" alt="zzxming"/><br /><sub><b>zzxming</b></sub></a><br /><a href="https://github.com/opentiny/tiny-editor/commits?author=zzxming" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Janson1012"><img src="https://avatars.githubusercontent.com/u/60996238?v=4?s=100" width="100px;" alt="Janson1012"/><br /><sub><b>Janson1012</b></sub></a><br /><a href="https://github.com/opentiny/tiny-editor/commits?author=Janson1012" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://kagol.github.io/blogs"><img src="https://avatars.githubusercontent.com/u/9566362?v=4?s=100" width="100px;" alt="Kagol"/><br /><sub><b>Kagol</b></sub></a><br /><a href="https://github.com/opentiny/tiny-editor/commits?author=kagol" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/kiss-keray"><img src="https://avatars.githubusercontent.com/u/24504763?v=4?s=100" width="100px;" alt="keray"/><br /><sub><b>keray</b></sub></a><br /><a href="https://github.com/opentiny/tiny-editor/commits?author=kiss-keray" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/qwangry"><img src="https://avatars.githubusercontent.com/u/58112936?v=4?s=100" width="100px;" alt="qwangry"/><br /><sub><b>qwangry</b></sub></a><br /><a href="https://github.com/opentiny/tiny-editor/commits?author=qwangry" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jany55555"><img src="https://avatars.githubusercontent.com/u/173228510?v=4?s=100" width="100px;" alt="jany55555"/><br /><sub><b>jany55555</b></sub></a><br /><a href="https://github.com/opentiny/tiny-editor/commits?author=jany55555" title="Code">💻</a></td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit 3cfa8e3

Please sign in to comment.