Skip to content

Commit cf57a7d

Browse files
fangsmilefangsmile
committed
chore: initial open source release
0 parents  commit cf57a7d

1,188 files changed

Lines changed: 317242 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

‎.gitattributes‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Don't allow people to merge changes to these generated files, because the result
2+
# may be invalid. You need to run "rush update" again.
3+
pnpm-lock.yaml merge=text
4+
shrinkwrap.yaml merge=binary
5+
npm-shrinkwrap.json merge=binary
6+
yarn.lock merge=binary
7+
8+
# Rush's JSON config files use JavaScript-style code comments. The rule below prevents pedantic
9+
# syntax highlighters such as GitHub's from highlighting these comments as errors. Your text editor
10+
# may also require a special configuration to allow comments in JSON.
11+
#
12+
# For more information, see this issue: https://github.com/microsoft/rushstack/issues/1088
13+
#
14+
*.json linguist-language=JSON-with-Comments

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: Bug Report
2+
description: Report a bug to @VisActor/vgraph
3+
title: '[Bug] '
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
The issue list is reserved exclusively for bug reports and feature requests.
10+
11+
For usage questions, please use the following resources:
12+
13+
- Read the [docs](https://www.visactor.io/vgraph)
14+
- Find in [examples](https://www.visactor.io/vgraph/example)
15+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/visactor)
16+
17+
For non-technical support or general questions, you can email [xuanhun521@126.com](mailto:xuanhun521@126.com).
18+
19+
Also try to search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue using the form below instead of commenting on the old issue.
20+
21+
# - type: checkboxes
22+
# attributes:
23+
# label: Is there an existing issue for this?
24+
# description: Please search to see if an issue already exists for the bug you encountered.
25+
# options:
26+
# - label: I have searched the existing issues
27+
# required: true
28+
29+
- type: input
30+
attributes:
31+
label: Version
32+
description: |
33+
Check if the issue is reproducible with the latest stable version of @VisActor/vgraph.
34+
placeholder: |
35+
e.g. 1.0.0
36+
37+
validations:
38+
required: true
39+
40+
- type: input
41+
attributes:
42+
label: Link to Minimal Reproduction
43+
description: |
44+
If the reproduction does not need a build setup, please provide a link to [Official Editor](https://www.visactor.io/vgraph/demo/table-type/list-table), [codesandbox](https://codesandbox.io/p/sandbox/vgraph-list-table-jw8yr8). If it requires a build setup, you can use [CodeSandbox](https://codesandbox.io/p/sandbox/vgraph-bug-report-dd9pfl?file=%2Fsrc%2Findex.ts%3A57%2C11) or provide a GitHub repo.
45+
The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed to show the bug.
46+
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided. [Why?](https://antfu.me/posts/why-reproductions-are-required)
47+
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
attributes:
53+
label: Steps to Reproduce
54+
description: |
55+
What do we need to do after opening your repo in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code.
56+
57+
placeholder: |
58+
1. How do you create the view
59+
2. What's the spec of view
60+
3. User interactions before the error happens.
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
attributes:
66+
label: Current Behavior
67+
description: A concise description of what you're experiencing.
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
attributes:
73+
label: Expected Behavior
74+
description: A concise description of what you expected to happen.
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
attributes:
80+
label: Environment
81+
description: |
82+
e.g.
83+
- **OS**: macOS Monterey
84+
- **Browser**: Chrome 96.0.4664.55
85+
- **Framework** Vue@3
86+
value: |
87+
- OS:
88+
- Browser:
89+
- Framework:
90+
render: markdown
91+
92+
validations:
93+
required: false
94+
95+
- type: textarea
96+
attributes:
97+
label: Any additional comments?
98+
description: |
99+
e.g. some background/context of how you ran into this bug.
100+
101+
validations:
102+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
# contact_links:
3+
# - name: @VisaActor/vgraph
4+
# url: https://www.visactor.io/
5+
# about: Please search question here before opening a new issue

‎.github/ISSUE_TEMPLATE/docs_request.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Documentation Request
2+
description: Request for improvements or additions to the documentation
3+
title: '[Documentation] '
4+
labels: [docs]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
The documentation is an important part of the project, and we welcome any suggestions for improvement. If you find any issues or have any suggestions for the documentation, please feel free to open an issue.
10+
11+
Please provide as much detail as possible when submitting an issue, including the following information:
12+
13+
- The title of the documentation page or section you are referring to
14+
- A description of the issue or suggestion
15+
- Any relevant code snippets or examples
16+
- Screenshots or other visual aids if applicable
17+
18+
We will review your issue as soon as possible and work with you to improve the documentation.
19+
20+
- type: textarea
21+
attributes:
22+
label: Documentation Title or Section
23+
description: Please enter the title or section of the documentation you are referring to.
24+
placeholder: For example, "Getting Started Guide" or "API Reference"
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
attributes:
30+
label: Issue Description or Suggestion
31+
description: Please describe the issue or suggestion you have for the documentation.
32+
placeholder: For example, "The installation instructions are not clear" or "I suggest adding a tutorial on how to use the API"
33+
validations:
34+
required: true

‎.github/ISSUE_TEMPLATE/feaure_request.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature Request
2+
description: Request a new feature from @VisActor/vgraph
3+
title: '[Feature] '
4+
labels: [feature]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
The issue list is reserved exclusively for bug reports and feature requests.
10+
11+
For usage questions, please use the following resources:
12+
13+
- Read the [docs](https://www.visactor.io/vgraph)
14+
- Find in [examples](https://www.visactor.io/vgraph/example)
15+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/visactors)
16+
17+
For non-technical support or general questions, you can email [xuanhun521@126.com](mailto:xuanhun521@126.com).
18+
19+
Also try to search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue using the form below instead of commenting on the old issue.
20+
21+
- type: textarea
22+
attributes:
23+
label: What problem does this feature solve?
24+
description: |
25+
Explain your use case, context, and rationale behind this feature request. More importantly, what is the end user experience you are trying to build that led to the need for this feature?
26+
27+
An important design goal of @VisActor/vgraph is keeping the API surface small and straightforward. In general, we only consider adding new features that solve a problem that cannot be easily dealt with using existing APIs (i.e. not just an alternative way of doing things that can already be done). The problem should also be common enough to justify the addition.
28+
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
attributes:
34+
label: What does the proposed API look like?
35+
description: Describe how you propose to solve the problem and provide code samples of how the API would work once implemented. Note that you can use [Markdown](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format your code blocks.
36+
37+
validations:
38+
required: true

‎.github/ISSUE_TEMPLATE/others.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Others
3+
about: Describe this issue's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<!--
2+
First of all, thank you for your contribution! 😄
3+
For requesting to pull a new feature or bugfix, please send it from a feature/bugfix branch based on the `main` branch.
4+
Before submitting your pull request, please make sure the checklist below is confirmed.
5+
Your pull requests will be merged after one of the collaborators approve.
6+
Thank you!
7+
-->
8+
9+
[[中文版模板 / Chinese template](https://github.com/VisActor/VGraph/blob/main/.github/PULL_REQUEST_TEMPLATE/pr_cn.md?plain=1)]
10+
11+
### 🤔 This is a ...
12+
13+
- [ ] New feature
14+
- [ ] Bug fix
15+
- [ ] TypeScript definition update
16+
- [ ] Bundle size optimization
17+
- [ ] Performance optimization
18+
- [ ] Enhancement feature
19+
- [ ] Refactoring
20+
- [ ] Update dependency
21+
- [ ] Code style optimization
22+
- [ ] Test Case
23+
- [ ] Branch merge
24+
- [ ] Site / documentation update
25+
- [ ] Demo update
26+
- [ ] Workflow
27+
- [ ] Chore
28+
- [ ] Release
29+
- [ ] Other (about what?)
30+
31+
### 🔗 Related issue link
32+
33+
<!--
34+
1. Put the related issue or discussion links here.
35+
2. close #xxxx or fix #xxxx for instance.
36+
-->
37+
38+
### 💡 Background and solution
39+
40+
<!--
41+
1. Describe the problem and the scenario.
42+
2. GIF or snapshot should be provided if includes UI/interactive modification.
43+
3. How to fix the problem, and list the final API implementation and usage sample if that is a new feature.
44+
-->
45+
46+
### 📝 Changelog
47+
48+
<!--
49+
Describe changes from the user side, and list all potential break changes or other risks.
50+
--->
51+
52+
| Language | Changelog |
53+
| ---------- | --------- |
54+
| 🇺🇸 English | |
55+
| 🇨🇳 Chinese | |
56+
57+
### ☑️ Self-Check before Merge
58+
59+
⚠️ Please check all items below before requesting a reviewing. ⚠️
60+
61+
- [ ] Doc is updated/provided or not needed
62+
- [ ] Demo is updated/provided or not needed
63+
- [ ] TypeScript definition is updated/provided or not needed
64+
- [ ] Changelog is provided or not needed
65+
66+
---
67+
68+
<!--
69+
Below are template for copilot to generate CR message.
70+
Please DO NOT modify it.
71+
-->
72+
73+
### 🚀 Summary
74+
75+
copilot:summary
76+
77+
### 🔍 Walkthrough
78+
79+
copilot:walkthrough

‎.github/PULL_REQUEST_TEMPLATE/pr_cn.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<!--
2+
首先，感谢您参与代码贡献! 😄
3+
为了提交新的功能或修改,请在主分支`main`分支上拉取开发分支 。
4+
在提交PR 之前，请确认下面列到的一些内容
5+
你的PR在核心成员review后，合并到主分支
6+
谢谢！
7+
-->
8+
9+
### 🤔 这个分支是...
10+
11+
- [ ] 新功能
12+
- [ ] Bug fix
13+
- [ ] Ts 类型更新
14+
- [ ] 打包优化
15+
- [ ] 性能优化
16+
- [ ] 功能增强
17+
- [ ] 重构
18+
- [ ] 依赖版本更新
19+
- [ ] 代码优化
20+
- [ ] 测试 case 更新
21+
- [ ] 分支合并
22+
- [ ] 网站/文档更新
23+
- [ ] demo 更新
24+
- [ ] Workflow
25+
- [ ] 配置修改
26+
- [ ] 发布
27+
- [ ] 其他 (具体是什么，请补充?)
28+
29+
### 🔗 相关 issue 连接
30+
31+
<!--
32+
1. 相关的issue或者讨论，请贴在这里.
33+
2. close #xxxx or fix #xxxx for instance.
34+
-->
35+
36+
### 💡 问题的背景&解决方案
37+
38+
<!--
39+
1. 描述问题和场景
40+
2. 如果包含UI/交互相关的修改，请提供GIF或者截图
41+
3. 提供如何解决问题的，如果是开发新的功能，请提供最终的API实现和使用案例
42+
-->
43+
44+
### 📝 Changelog
45+
46+
<!--
47+
描述用户侧的修改，并列出所有可能的新功能、修改、以及风险
48+
--->
49+
50+
| Language | Changelog |
51+
| ---------- | --------- |
52+
| 🇺🇸 English | |
53+
| 🇨🇳 Chinese | |
54+
55+
### ☑️ 自测
56+
57+
⚠️ 在提交 PR 之前，请检查一下内容. ⚠️
58+
59+
- [ ] 文档提供了，或者更新，或者不需要
60+
- [ ] Demo 提供了，或者更新，或者不需要
61+
- [ ] Ts 类型定义提供了，或者更新，或者不需要
62+
- [ ] Changelog 提供了，或者不需要
63+
64+
---
65+
66+
<!--
67+
Below are template for copilot to generate CR message.
68+
Please DO NOT modify it.
69+
-->
70+
71+
### 🚀 Summary
72+
73+
copilot:summary
74+
75+
### 🔍 Walkthrough
76+
77+
copilot:walkthrough

0 commit comments

Comments
 (0)