Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1.65 KB
Raw

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 👌
Please check out the existing issues and discussions before you open a new one.

🐛 Bug Reports

For reporting bugs, please create a new issue.

☝️ General Usage

When you have questions about the general usage of React Flow you can use the Q & A section or the Discord channel.

✨ Feature Requests

If you are missing a certain feature, please use the New Features discussion section.

📝 Docs

The docs have its own react-flow-docs repo. Please open an issue or pull request there if you are missing something.

💫 Pull Requests

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