Skip to content

Commit 278f730

Browse files
committed
docs(en):Improve the document and correct any errors in it
1 parent d191683 commit 278f730

1 file changed

Lines changed: 23 additions & 15 deletions

File tree

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@ English | [简体中文](README-CN.md)
2121
- [Table of Contents](#table-of-contents)
2222
- [1. Introduction](#1-introduction)
2323
- [2. Documentation](#2-documentation)
24-
- [4. Prerequisites](#4-prerequisites)
25-
- [5. Build](#5-build)
26-
- [6. Testing](#6-testing)
27-
- [6.1 Test Execution](#61-test-execution)
28-
- [6.2 Test Case Addition](#62-test-case-addition)
29-
- [6.3 Performance Testing](#63-performance-testing)
24+
- [3. Prerequisites](#3-prerequisites)
25+
- [4. Build](#4-build)
26+
- [5. Testing](#5-testing)
27+
- [5.1 Test Execution](#51-test-execution)
28+
- [5.2 Test Case Addition](#52-test-case-addition)
29+
- [5.3 Performance Testing](#53-performance-testing)
30+
- [6. CI/CD](#6-cicd)
3031
- [7. Submitting Issues](#7-submitting-issues)
3132
- [8. Submitting PRs](#8-submitting-prs)
3233
- [9. References](#9-references)
@@ -38,23 +39,24 @@ English | [简体中文](README-CN.md)
3839

3940
## 2. Documentation
4041

41-
- For development examples, see [Developer Guide](https://docs.tdengine.com/developer-guide/), which includes examples of data writing, querying, schemaless writing, parameter binding, and data subscription.
42-
- For other reference information, see [Reference Manual](https://docs.tdengine.com/tdengine-reference/client-libraries/node/), which includes version history, data types, example programs, API descriptions, and FAQs.
42+
- To use Node.js connector, please check [Developer Guide](https://docs.tdengine.com/developer-guide/), which includes how an application can introduce the `@tdengine/websocket`, as well as examples of data writing, querying, schemaless writing, parameter binding, and data subscription.
43+
- For other reference information, please check [Reference Manual](https://docs.tdengine.com/tdengine-reference/client-libraries/node/), which includes version history, data types, example programs, API descriptions, and FAQs.
44+
- This quick guide is mainly for developers who like to contribute/build/test the Node.js connector by themselves. To learn about TDengine, you can visit the [official documentation](https://docs.tdengine.com).
4345

44-
## 4. Prerequisites
46+
## 3. Prerequisites
4547

4648
- Install the Node.js development environment, using version 14 or above. Download link: [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
4749
- Install the Node.js connector using npm.
4850
- Install TypeScript 5.3.3 and above using npm.
49-
- TDengine has been deployed locally. For specific steps, please refer to Deploy TDengine, and `taosd` and `taosAdapter` have been started.
51+
- TDengine has been deployed locally. For specific steps, please refer to [Deploy TDengine](https://docs.tdengine.com/get-started/deploy-from-package/), and `taosd` and `taosAdapter` have been started.
5052

51-
## 5. Build
53+
## 4. Build
5254

5355
Execute `tsc` to build the project in the 'nodejs' directory.
5456

55-
## 6. Testing
57+
## 5. Testing
5658

57-
### 6.1 Test Execution
59+
### 5.1 Test Execution
5860

5961
Execute `npm run test` in the project directory to run the tests. The test cases will connect to the local TDengine server and taosAdapter for testing.
6062
After running the tests, the result similar to the following will be printed eventually. If all test cases pass, without any failures or errors.
@@ -67,15 +69,20 @@ Time: 20.373 s
6769
Ran all test suites.
6870
```
6971

70-
### 6.2 Test Case Addition
72+
### 5.2 Test Case Addition
7173

7274
All tests are located in the `nodejs/test/bulkPulling` directory of the project. You can add new test files or add test cases in existing test files.
7375
The test cases use the jest framework. Generally, a connection is established and a database is created in the `beforeAll` method, and the database is droped and the connection is released in the `afterAll` method.
7476

75-
### 6.3 Performance Testing
77+
### 5.3 Performance Testing
7678

7779
Performance testing is in progress.
7880

81+
## 6. CI/CD
82+
83+
- [Build Workflow](https://github.com/taosdata/taos-connector-node/actions/workflows/build.yaml)
84+
- [Code Coverage](https://app.codecov.io/gh/taosdata/taos-connector-node)
85+
7986
## 7. Submitting Issues
8087

8188
We welcome the submission of [GitHub Issue](https://github.com/taosdata/taos-connector-node/issues/new?template=Blank+issue). When submitting, please provide the following information:
@@ -95,6 +102,7 @@ We welcome developers to contribute to this project. When submitting PRs, please
95102
1. Modify the code, ensure all unit tests pass, and add new unit tests to verify the changes.
96103
1. Push the changes to the remote branch (`git push origin my_branch`).
97104
1. Create a Pull Request on GitHub ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)).
105+
1. After submitting the PR, you can find your PR through the [Pull Request](https://github.com/taosdata/taos-connector-node/pulls). Click on the corresponding link to see if the CI for your PR has passed. If it has passed, it will display "All checks have passed". Regardless of whether the CI passes or not, you can click "Show all checks" -> "Details" to view the detailed test case logs.
98106
1. After submitting the PR, if CI passes, you can find your PR on the [codecov](https://app.codecov.io/gh/taosdata/taos-connector-node/pulls) page to check the test coverage.
99107

100108
## 9. References

0 commit comments

Comments
 (0)