alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(contributing): format text

Browse Source
This commit is contained in:
Moritz Klack
2021-04-24 16:26:30 +02:00
committed by GitHub
parent 524f46f41b
commit dc7f261339
1 changed files with 4 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+4 -8
View File
@@ -1,10 +1,8 @@
# React Flow Contribution Guidlines # React Flow Contribution Guidlines
Thanks for your interest in contributing to React Flow 🙌 Thanks for your interest in contributing to React Flow 🙌
Every form of contribution is appreciated. From issue reports to pull requests and documentation 👌
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
@@ -24,12 +22,10 @@ The docs have its own [react-flow-docs repo](https://github.com/wbkd/react-flow-
### 💫 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. 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` 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` 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 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 4. Run tests `npm test` and add new ones if you are introducing a new feature