Merge branch 'main' of github.com:wbkd/react-flow into main
This commit is contained in:
+10
-13
@@ -1,34 +1,31 @@
|
||||
# React Flow Contribution Guidlines
|
||||
# React Flow Contribution Guidelines
|
||||
|
||||
Thanks for your interest in contributing to React Flow 🙌
|
||||
Every form of contribution is appreciated. From issue reports to pull requests and documentation 👌
|
||||
Thanks for your interest in contributing to React Flow 🙌
|
||||
Every form of contribution is appreciated. From issue reports to pull requests and documentation 👌
|
||||
Please check out the [existing issues](https://github.com/wbkd/react-flow/issues) and [discussions](https://github.com/wbkd/react-flow/discussions) before you open a new one.
|
||||
|
||||
Please check out the [exisitng issues](https://github.com/wbkd/react-flow/issues) and [discussions](https://github.com/wbkd/react-flow/discussions) before you open a new one.
|
||||
|
||||
## 🐛 Bug Reports
|
||||
#### 🐛 Bug Reports
|
||||
|
||||
For reporting bugs, please create a [new issue](https://github.com/wbkd/react-flow/issues/new/choose).
|
||||
|
||||
## ☝️ General Usage
|
||||
#### ☝️ General Usage
|
||||
|
||||
When you have questions about the general usage of React Flow you can use the [Q & A section](https://github.com/wbkd/react-flow/discussions/categories/q-a) or the [Discord channel](https://discord.gg/Bqt6xrs).
|
||||
|
||||
## ✨ Feature Requests
|
||||
#### ✨ Feature Requests
|
||||
|
||||
If you are missing a certain feature, please use the [New Features](https://github.com/wbkd/react-flow/discussions/categories/new-features) discussion section.
|
||||
|
||||
## 📝 Docs
|
||||
#### 📝 Docs
|
||||
|
||||
The docs have its own [react-flow-docs repo](https://github.com/wbkd/react-flow-docs). Please open an issue or pull request there if you are missing something.
|
||||
|
||||
## 💫 Pull Requests
|
||||
#### 💫 Pull Requests
|
||||
|
||||
If you want to contribute improvements or new features we are happy to review your PR :)
|
||||
If you want to contribute improvements or new features we are happy to review your PR :)
|
||||
Please use a meaningful commit message and add a little description of your changes.
|
||||
|
||||
1. Install dependencies `npm install` and example dependencies `cd example && npm install`
|
||||
2. Run library start task `npm start` and example start task `cd example && npm start`
|
||||
3. No you can test your changes with the exisiting examples. Feel free to add a new one if it's needed for your changes
|
||||
4. Run tests `npm test` and add new ones if you are introducing a new feature
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user