docs: support contributing for vstory

VisActor · Nov 29, 2024 · cb5a272 · cb5a272
1 parent bbe66c1
commit cb5a272
Show file tree

Hide file tree

Showing 12 changed files with 1,929 additions and 0 deletions.
diff --git a/docs/assets/contributing/en/1-Setting-Up-the-Development-Environment.md b/docs/assets/contributing/en/1-Setting-Up-the-Development-Environment.md
@@ -0,0 +1,123 @@
+---
+title: 1. Setting up Development Environment
+
+key words: VisActor, VChart, VTable, VStrory, 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 open the [Github website](https://github.com/), click the `Sign up` button in the upper right corner, register your own account, and start your open source journey.
+
+If, due to special circumstances, you are unable to access the Github site, please inform us and proceed with project development through [Gitee](https://gitee.com/VisActor/VStory).
+
+## 1.2 Fork the Project
+
+First, you need to fork this project. Go to the [VStory project page](https://github.com/VisActor/VStory) and click the Fork button in the upper right corner.
+
+
+
+<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/LQbyb5XWgoV8w2x3D5uc8bIkn1c.gif' alt='' width='1000' height='auto'>
+
+
+
+Your github account will show the project xxxx(your github username)/vstory
+
+<img src='https://cdn.jsdelivr.net/gh/xuanhun/articles/visactor/img/OuwMbtoyPof0S8xrisscWJ3Hneb.gif' 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 used to track and manage code changes in software development projects. It helps developers record and manage the history of code, facilitating team collaboration, code version control, code merging, and other operations. With Git, you can track every version of each file and easily switch and compare between different versions. Git also provides branch management functionality, allowing multiple parallel development tasks to be carried out simultaneously.
+
+* 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 installation wizard instructions.
+
+* After installation, you can confirm the successful installation by using the `git version` command in the command line.
+
+```
+HM4G2J09L6:~ xuanhun$ git version
+**git version 2.39.2 (Apple Git-143)**
+
+```
+## 2.2 Install Development Tools (Recommended: VSCode)
+
+VisActor is mainly based on the front-end technology stack, and there are many tools available for front-end development. We recommend using VSCode. Of course, you can also use your preferred development tool.
+
+If you are not familiar with VSCode, it is recommended to read the official documentation: [https://vscode.js.cn/docs/setup/setup-overview](https://vscode.js.cn/docs/setup/setup-overview)
+
+## 2.3 Install Marscode AI Programming Assistant
+
+[Marscode AI Programming Assistant](https://www.marscode.cn/home?utm_source=developer&utm_medium=oss&utm_campaign=visactor_a)
+
+Marscode AI Programming Assistant is an AI programming assistant provided by Marscode, offering AI features such as intelligent code completion. It supports mainstream programming languages and IDEs, providing suggestions for writing single lines of code or entire functions during development. Additionally, it supports features such as code interpretation, unit test generation, and issue fixing, improving development efficiency and quality. For more information, please refer to the [documentation of Marscode AI Programming Assistant](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 easily perform tasks such as code understanding, document writing, feature development, and unit testing. Detailed examples will be provided in the contribution guidelines for various tasks.
+
+<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
+
+Navigate to the VStory folder and add the remote address of VStory.
+
+```
+git remote add upstream https://github.com/VisActor/VStory.git
+
+```
+Get the latest source code of VStory.
+
+```
+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
+
+```
+Next, run the command to view the demo.
+
+```
+# Install dependencies
+$ rush update
+# Start the demo page of vstory
+$ rush start
+# Start the local documentation site
+$ rush docs
+
+```
+# Next Steps
+
+By now, you have prepared for developing the code. Please continue reading the next section of the tutorial to start different types of tasks.
+
+Github: [github.com/VisActor](https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FVisActor)
+
+Leave a message on the VisActor WeChat subscription account (you can join the WeChat group through the subscription account 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](https://discord.com/invite/3wPyxVyH6m)
+
+
+# This document is contributed by the following individuals
+
+[玄魂](https://github.com/xuanhun)
diff --git a/docs/assets/contributing/en/2-Howto Submit an Issue.md b/docs/assets/contributing/en/2-Howto Submit an Issue.md
@@ -0,0 +1,61 @@
+---
+title: 2. How to Raise an Issue
+
+key words: VisActor, VChart, VTable, VStory, VMind, VGrammar, VRender, Visualization, Chart, Data, Table, Graph, Gis, LLM
+---
+Under the issues section of each project, you can create and search for issues.
+
+For example, in the VStory project: [VStory issues](https://github.com/VisActor/VStory/issues)
+
+<img src='https://lf9-dp-fe-cms-tos.byteorg.com/obj/bit-cloud/vstory/vstory-issue.png' alt='' width='1000' height='auto'>
+
+# Check for Existing Issues
+
+You can use the search filter to check the details of existing issues to see if a similar issue already exists.
+
+# Create an Issue
+
+If you don't find a similar issue, 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
+
+After filling out the issue form, click the "Submit new issue" button to submit your issue.
+
+# Follow Up on the Issue
+
+Once you've submitted the issue, you can check the status of your issue in the repository's "Issues" tab. The project developers may ask for more information or inform you that they are working on 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 can also close the issue yourself if you believe the problem has been resolved or no longer requires further assistance.
+
+By following these steps, you can successfully raise an issue for an open-source project on GitHub. Remember to describe the issue in as much detail and clarity as possible, as this will help the project developers understand and address your problem more quickly.
+
+# Next Steps
+
+By now, you are familiar with the concept of raising issues. Next, please continue reading the next section of the tutorial to start different types of tasks.
+
+GitHub: [github.com/VisActor](https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FVisActor)
+
+VisActor WeChat subscription account (you can join the WeChat group through the subscription account 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)
+
+
+# Contributors to this Document
+
+[玄魂](https://github.com/xuanhun)