(incubator-fury) branch main updated: docs(JavaScript): Add build and test documentation for JavaScript (#1360)

[wangweipeng]

This is an automated email from the ASF dual-hosted git repository.

wangweipeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-fury.git


The following commit(s) were added to refs/heads/main by this push:
     new ba374001 docs(JavaScript): Add build and test documentation for 
JavaScript (#1360)
ba374001 is described below

commit ba374001dc9b6905171dbea7ca0dd64cbf09316d
Author: LiangliangSui <116876207+liangliang...@users.noreply.github.com>
AuthorDate: Tue Jan 30 11:28:48 2024 +0800

    docs(JavaScript): Add build and test documentation for JavaScript (#1360)
---
 CONTRIBUTING.md           | 22 +++++++++++++++++++---
 docs/guide/DEVELOPMENT.md | 18 ++++++++++++++++++
 2 files changed, 37 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1f8c33e3..22115e0d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # How to contribute to Fury
 
-## 🔎 Finding good first issues
+## Finding good first issues
 
 See [Good First Issues](https://github.com/apache/incubator-fury/contribute).
 
@@ -20,7 +20,9 @@ For example, here are good PR titles:
 
 For more details, please check [pr-lint.yml](./.github/workflows/pr-lint.yml).
 
-## 🧪 Testing
+## Testing
+
+For environmental requirements, please check 
[DEVELOPMENT.md](./docs/guide/DEVELOPMENT.md).
 
 ### Python
 
@@ -57,7 +59,14 @@ cd rust
 cargo test
 ```
 
-## 😎 Code Style
+### JavaScript
+
+```bash
+cd javascript
+npm run test
+```
+
+## Code Style
 
 Run all checks: `bash ci/format.sh --all`.
 
@@ -108,6 +117,13 @@ cd rust
 cargo fmt
 ```
 
+### JavaScript
+
+```bash
+cd javascript
+npm run lint
+```
+
 ## Debug
 
 ### Java
diff --git a/docs/guide/DEVELOPMENT.md b/docs/guide/DEVELOPMENT.md
index bdc5d591..5d71166a 100644
--- a/docs/guide/DEVELOPMENT.md
+++ b/docs/guide/DEVELOPMENT.md
@@ -82,3 +82,21 @@ cargo test
 ```bash
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
+
+### Build Fury JavaScript
+
+```bash
+cd javascript
+npm install
+
+# run build
+npm run build
+# run test
+npm run test
+```
+
+#### Environment Requirements
+
+- node 14+
+- npm 8+
+


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@fury.apache.org
For additional commands, e-mail: commits-h...@fury.apache.org