You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,32 +2,32 @@
2
2
3
3
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:
- 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
- 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
7
7
- Submit Pull requests to fix typos in the documentation or to make the documentation clearer and more comprehensive
8
8
- Add the official assistant WeChat: opentiny-official (note: TinyEditor), join the technical discussion group
9
9
10
10
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:
11
11
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)
13
13
- Implementing new features
14
14
- Improving unit tests
15
15
- Translating documentation
16
16
- Participating in code reviews
17
17
18
18
## Submitting Issues
19
19
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.
21
21
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`.
23
23
24
24
The Issue for reporting defects mainly requires the following information:
25
25
26
26
- The version number of `@opentiny/fluent-editor`
27
27
- The manifestation of the defect, which can be supplemented with screenshots, and if there is an error, the error message can be pasted
28
28
- The reproduction steps of the defect, preferably providing a minimal reproducible demo link
29
29
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`.
31
31
32
32
The Issue for new features mainly requires the following information:
33
33
@@ -36,7 +36,7 @@ The Issue for new features mainly requires the following information:
36
36
37
37
## Submitting PRs
38
38
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.
40
40
41
41
### Pull Request Standards
42
42
@@ -71,20 +71,20 @@ The PR description uses a template and requires filling in the relevant PR infor
71
71
72
72
### Local Startup Steps
73
73
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
75
75
- Clone your personal repository to the local
76
76
- Associate the upstream repository to synchronize the latest code from the upstream repository
77
77
- Run `pnpm i` in the root directory of TinyEditor to install dependencies
78
78
- 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/)
80
80
81
81
```shell
82
82
# username is the username, please replace it before execution
- 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/)
99
99
- Synchronize the latest code from the upstream repository main branch: git pull upstream main
100
100
- 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`
101
101
- Local coding
102
102
- 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
103
103
- 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
105
105
- Supplement the relevant information according to the PR template, including PR checklist, PR type, associated Issue number, whether it is a destructive change
106
106
- The project Committer conducts Code Review and provides feedback
107
107
- 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
0 commit comments