Skip to content

Commit 248de60

Browse files
committed
Merge branch 'main' into v10
2 parents 6bbd06a + fe3dc7d commit 248de60

File tree

5 files changed

+854
-730
lines changed

5 files changed

+854
-730
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: '🐛 Bug report'
2+
description: Create a report to help us improve React Flow
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for reporting an issue :pray:.
8+
9+
This issue tracker is for reporting bugs found in react-flow (https://github.com/wbkd/react-flow)
10+
If you have a question about how to achieve something and are struggling, please post a question
11+
inside of react-flow's Discussion's tab: https://github.com/wbkd/react-flow/discussions
12+
If it's an issue about the docs please go to the react-flow-docs (https://github.com/wbkd/react-flow-docs)
13+
14+
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
15+
- react-flow's Open Issue's tab: https://github.com/wbkd/react-flow/issues?q=is%3Aissue+sort%3Aupdated-desc+position
16+
- react-flow's Closed Issues tab: https://github.com/wbkd/react-flow/issues?q=is%3Aissue+sort%3Aupdated-desc+position+is%3Aclosed
17+
- react-flow's Discussion's tab: https://github.com/wbkd/react-flow/discussions
18+
19+
The more information you fill in, the better the community can help you.
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Describe the Bug
24+
description: Provide a clear and concise description of the challenge you are running into.
25+
validations:
26+
required: true
27+
- type: input
28+
id: link
29+
attributes:
30+
label: Your Example Website or App
31+
description: |
32+
Which website or app were you using when the bug happened?
33+
Note:
34+
- Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `react-flow-renderer` npm package.
35+
- To create a shareable code example you can use Codesandbox (https://codesandbox.io/s/react-flow-starter-ou8or) or Stackblitz (https://stackblitz.com/).
36+
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
37+
placeholder: |
38+
e.g. https://stackblitz.com/edit/...... OR Github Repo
39+
validations:
40+
required: false
41+
- type: textarea
42+
id: steps
43+
attributes:
44+
label: Steps to Reproduce the Bug or Issue
45+
description: Describe the steps we have to take to reproduce the behavior.
46+
placeholder: |
47+
1. Go to '...'
48+
2. Click on '....'
49+
3. Scroll down to '....'
50+
4. See error
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: expected
55+
attributes:
56+
label: Expected behavior
57+
description: Provide a clear and concise description of what you expected to happen.
58+
placeholder: |
59+
As a user, I expected ___ behavior but i am seeing ___
60+
validations:
61+
required: true
62+
- type: textarea
63+
id: screenshots_or_videos
64+
attributes:
65+
label: Screenshots or Videos
66+
description: |
67+
If applicable, add screenshots or a video to help explain your problem.
68+
For more information on the supported file image/file types and the file size limits, please refer
69+
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
70+
placeholder: |
71+
You can drag your video or image files inside of this editor ↓
72+
- type: textarea
73+
id: platform
74+
attributes:
75+
label: Platform
76+
value: |
77+
- OS: [e.g. macOS, Windows, Linux]
78+
- Browser: [e.g. Chrome, Safari, Firefox]
79+
- Version: [e.g. 91.1]
80+
validations:
81+
required: true
82+
- type: textarea
83+
id: additional
84+
attributes:
85+
label: Additional context
86+
description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🤔 Feature Requests & Questions
4+
url: https://github.com/wbkd/react-flow/discussions
5+
about: Please ask and answer questions in the discussions section

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
[![react-flow](https://user-images.githubusercontent.com/2857535/95224198-b2540000-07fa-11eb-832d-361d72d60345.jpg)](https://reactflow.dev)
22

3-
React Flow is a library for building node-based graphs. You can easily implement custom node types and it comes with components like a mini-map and graph controls. Feel free to check out the [examples](https://reactflow.dev/) or read the [blog post](https://webkid.io/blog/react-flow-node-based-graph-library/) to get started.
3+
React Flow is a library for building node based graphs. You can easily implement custom node types and it comes with components like a mini map and graph controls. Feel free to check out the [examples](https://reactflow.dev/) or read the [blog post](https://webkid.io/blog/react-flow-node-based-graph-library/) to get started.
4+
5+
## 👉 Next Major Release 👈
6+
7+
We are currently working on the next version. You can find the installation instructions and breaking changes in [this PR](https://github.com/wbkd/react-flow/pull/1555). Your feedback is highly appreciated :)
48

59
- **Website:** https://reactflow.dev
610
- **Documentation:** https://reactflow.dev/docs
711
- **Examples:** https://reactflow.dev/examples
812
- **Website/Docs Repository:** https://github.com/wbkd/react-flow-docs
913
- **Community:** https://discord.gg/Bqt6xrs
14+
- **Sponsorship:** https://github.com/sponsors/wbkd
1015

1116
React Flow was initially created for [datablocks](https://datablocks.pro). A node-based editor for transforming, analyzing and visualizing data.
1217

13-
1418
## Installation
1519

1620
```

0 commit comments

Comments
 (0)