-
Notifications
You must be signed in to change notification settings - Fork 186
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2973 from VisActor/release/1.11.5
[Auto release] release 1.11.5
- Loading branch information
Showing
81 changed files
with
3,480 additions
and
356 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
[{"definitionName":"lockStepVersion","policyName":"vtableMain","version":"1.11.4","mainProject":"@visactor/vtable","nextBump":"patch"}] | ||
[{"definitionName":"lockStepVersion","policyName":"vtableMain","version":"1.11.5","mainProject":"@visactor/vtable","nextBump":"patch"}] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
119 changes: 119 additions & 0 deletions
119
docs/assets/contributing/en/1-Setting-Up-the-Development-Environment.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
--- | ||
title: 1-Setting-Up-the-Development-Environment | ||
|
||
key words: VisActor, VChart, VTable, VStory, VMind, VGrammar, VRender, Visualization, Chart, Data, Table, Graph, GIS, LLM | ||
--- | ||
# Github | ||
|
||
## 1.1 Register an Account | ||
|
||
The VisActor team usually develops and maintains issues on GitHub. Please visit [GitHub](https://github.com/), click the `Sign up` button on the top right to register your account, and start your journey into open source. | ||
|
||
If you are unable to access GitHub due to certain restrictions, please let us know and use [Gitee](https://gitee.com/VisActor/VTable) for project development. | ||
|
||
## 1.2 Fork the Project | ||
|
||
First, you need to fork this project. Go to the [VTable project page](https://github.com/VisActor/VTable) and click the Fork button on the top right. | ||
|
||
<img src='https://lf9-dp-fe-cms-tos.byteorg.com/obj/bit-cloud/VTable/contributing/github-fork.png' alt='' width='1000' height='auto'> | ||
|
||
The project will appear as xxxx (your GitHub username)/vtable in your GitHub account. | ||
|
||
<img src='https://lf9-dp-fe-cms-tos.byteorg.com/obj/bit-cloud/VTable/contributing/github-fork-self.png' alt='' width='849' height='auto'> | ||
|
||
# Local Development Environment | ||
|
||
## 2.1 Install Git | ||
|
||
Since the code is hosted on GitHub, we use git for version control. | ||
|
||
Git is a version control system that helps track and manage code changes in software development projects. It aids developers in recording and managing code history, making team collaboration, code version control, and code merging easier. With Git, you can track each version of every file, switching and comparing between different versions easily. Git also offers branch management features, enabling simultaneous multiple parallel development tasks. | ||
|
||
* Visit the Git official website: [https://git-scm.com/](https://git-scm.com/) | ||
|
||
* Download the latest version of the Git installer. | ||
|
||
* Run the downloaded installer and follow the prompts in the installation wizard. | ||
|
||
* After installation, you can verify the installation by using `git version` in the command line. | ||
|
||
``` | ||
HM4G2J09L6:~ xuanhun$ git version | ||
**git version 2.39.2 (Apple Git-143)** | ||
``` | ||
|
||
## 2.2 Install a Development Tool (Recommended: VSCode) | ||
|
||
VisActor predominantly uses a frontend tech stack. There are many tools available for frontend development, but we recommend using VSCode. Of course, you can use any development tool you prefer. | ||
|
||
If you're not familiar with VSCode, it might be helpful to read the official documentation: https://vscode.js.cn/docs/setup/setup-overview | ||
|
||
## 2.3 Install Doubao Marscode AI Programming Assistant | ||
|
||
|
||
[Marscode AI Programming Assistant](https://www.marscode.cn/home?utm_source=developer&utm_medium=oss&utm_campaign=visactor_a) | ||
|
||
|
||
Doubao MarsCode Programming Assistant is an AI coding assistant from Doubao that provides AI features represented by intelligent code completion. It supports mainstream programming languages and IDEs, offering suggestions for writing a single line of code or an entire function during development. In addition, it offers features like code explanation, unit test generation, and problem fixing, improving development efficiency and quality. For more information, please refer to the [Doubao MarsCode Programming Assistant documentation](https://www.marscode.cn/home?utm_source=developer&utm_medium=oss&utm_campaign=visactor_a). | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/DLaKb4PysoADAZx0x1RcYjXbnBe.gif' alt='' width='760' height='auto'> | ||
|
||
With Marscode, VisActor developers can more easily understand code, write documentation, develop features, and perform unit testing. Detailed examples will be provided in specific task contribution guides. | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/BQeib7E2gonoOaxLPqjcRtAYngh.gif' alt='' width='1000' height='auto'> | ||
|
||
## 2.4 Clone the Code to Local | ||
|
||
Enter the VTable folder and add the remote address for VTable. | ||
|
||
``` | ||
git remote add upstream https://github.com/VisActor/VTable.git | ||
``` | ||
|
||
Get the latest source code for VTable. | ||
|
||
``` | ||
git pull upstream develop | ||
``` | ||
|
||
# Initialize the Project | ||
|
||
First, globally install [<u>@microsoft/rush</u>](https://rushjs.io/pages/intro/get_started/) | ||
|
||
``` | ||
$ npm i --global @microsoft/rush | ||
``` | ||
|
||
Then, execute the command to view the demo | ||
|
||
``` | ||
# Install dependencies | ||
$ rush update | ||
# Start the demo page for vtable | ||
$ cd ./packages/vtable && rushx demo | ||
# Start the demo page for react-vtable | ||
$ cd ./packages/react-vtable && rushx start | ||
# Start the local documentation site | ||
$ rush docs | ||
``` | ||
|
||
# Next Steps | ||
|
||
At this point, you have completed the preparations for developing the code. Please continue reading the next tutorial to begin working on different types of tasks. | ||
|
||
github: [github.com/VisActor](https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FVisActor) | ||
|
||
VisActor WeChat subscription message (you can join the WeChat group via the subscription menu): | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/KLjmbz9TtoGzPIxarv7cmhpgnSY.gif' alt='' width='258' height='auto'> | ||
|
||
VisActor official website: [www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%2Fwww.visactor.io%2Fvtable) | ||
|
||
Feishu group: | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/Cv9xb0zzLoUWyaxMVgccWuGPn7d.gif' alt='' width='264' height='auto'> | ||
|
||
discord: https://discord.com/invite/3wPyxVyH6m | ||
|
||
# This Document Was Contributed By | ||
[玄魂](https://github.com/xuanhun) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: 2. How to Submit an Issue | ||
|
||
key words: VisActor, VChart, VTable, VStrory, VMind, VGrammar, VRender, Visualization, Chart, Data, Table, Graph, Gis, LLM | ||
--- | ||
In each project's issues section, you can create, search, and manage issues. | ||
|
||
For example, VTable issues: [https://github.com/VisActor/VTable/issues](https://github.com/VisActor/VTable/issues) | ||
|
||
<img src='https://lf9-dp-fe-cms-tos.byteorg.com/obj/bit-cloud/VTable/contributing/github-issues.png' alt='' width='1000' height='auto'> | ||
|
||
# Check for Existing Issues | ||
|
||
You can determine if an issue already exists by using search filters and reviewing issue details. | ||
|
||
# Create a New Issue | ||
|
||
If no similar issue is found, you can click the "New issue" button. | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/DuonbEBS2oFVGJx7weQcP6Znnbb.gif' alt='' width='1000' height='auto'> | ||
|
||
Select "**Documentation Request**", click the "Get Start" button, and fill out the issue form. | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/C4j0bGZZvoc2RLxqEGgcRahTnAb.gif' alt='' width='1000' height='auto'> | ||
|
||
# **Submit the Issue** | ||
|
||
Once the issue form is completed, click the "Submit new issue" button to submit your issue. | ||
|
||
# **Follow Up on the Issue** | ||
|
||
After submission, you can monitor the status of your issue in the repository's "Issues" tab. The project developers might ask for more information or inform you that they are addressing the issue. | ||
|
||
# **Close the Issue** | ||
|
||
If your problem has been resolved or your request has been fulfilled, the project developers will close the issue. You may also close the issue yourself if you believe it has been resolved or if further assistance is no longer needed. | ||
|
||
By following these steps, you can successfully submit an issue for an open-source project on GitHub. Remember to be as detailed and clear as possible when describing your issue, as this helps project developers understand and resolve your problem more quickly. | ||
|
||
# Next Steps | ||
|
||
By now, you should be familiar with the concept of issues. Please continue reading the next section of the tutorial to start on different types of tasks. | ||
|
||
GitHub: [github.com/VisActor](https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FVisActor) | ||
|
||
VisActor WeChat Subscription (You can join the WeChat group via the subscription menu): | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/Cif0bZfEHoAmLgxSnqzclTqKnIf.gif' alt='' width='258' height='auto'> | ||
|
||
VisActor Official Website: [www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%2Fwww.visactor.io%2Fvtable) | ||
|
||
Feishu Group: | ||
|
||
<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/BOeVb2CDmozsl9xl8vcc7hzVn8c.gif' alt='' width='264' height='auto'> | ||
|
||
Discord: [https://discord.com/invite/3wPyxVyH6m](https://discord.com/invite/3wPyxVyH6m) | ||
|
||
# This Document Was Contributed By | ||
[玄魂](https://github.com/xuanhun) |
Oops, something went wrong.