chore(contributing): update

* Update CONTRIBUTING.md
* Update bug_report.yml
This commit is contained in:
John Robb
2023-05-02 10:39:06 +02:00
committed by GitHub
parent f79620f4c0
commit 22da0df68e
2 changed files with 27 additions and 14 deletions

View File

@@ -6,7 +6,7 @@ body:
value: |
Thank you for reporting an issue :pray:.
**Please only file issues for v10. Will will no longer fix issues for v9.**
**Please only file issues for v11. Will will no longer fix issues for v10.**
This issue tracker is for reporting bugs found in react-flow (https://github.com/wbkd/react-flow)
If you have a question about how to achieve something and are struggling, please post a question

View File

@@ -1,26 +1,39 @@
# React Flow Contribution Guidelines
# 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 👌
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.
Hello there! So glad you want to help out with React Flow 🤗 Youre the best. Heres a guide for how you can contribute to the project.
#### 🐛 Bug Reports
# Our Contributing Philosophy
For reporting bugs, please create a [new issue](https://github.com/wbkd/react-flow/issues/new/choose).
The direction of React Flow and which new features are added, and which are left out, is decided by the core team (sometimes referred to as a “cathedral” style of development). The core team is paid to do this work ([see how here](https://reactflow.dev/blog/asking-for-money-for-open-source/)). With this model we ensure that the people doing the most work on the library are paid for their time and effort, and that we prevent the library from bloating.
#### ☝️ General Usage
That being said, React Flow is only interesting because of the people who make things with it, share their work, and discuss it. Some of the most important and undervalued work in open source is from non-code contributions, and that is where we can use the most help from you.
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).
# How can I help?
#### ✨ Feature Requests
The things we need the most help for the library and its community are:
If you are missing a certain feature, please use the [New Features](https://github.com/wbkd/react-flow/discussions/categories/new-features) discussion section.
**🐛 Bug reports:** We simply cant catch them all. Check [existing issues](https://github.com/wbkd/react-flow/issues/new/choose) and discussion first, then [create a new issue](https://github.com/wbkd/react-flow/issues/new/choose) to tell us whats up.
#### 📝 Docs
**💬 Answering questions** in our [Discord Server](https://discord.gg/Bqt6xrs) and [Github discussions](https://github.com/wbkd/react-flow/discussions).
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.
🎬 **Create tutorials** for React Flow. Send them to us and well happily share them!
#### 💫 Pull Requests
** Edit our [Docs](https://reactflow.dev/docs/introduction/)**: Make changes in the [react-flow-docs repo](https://github.com/wbkd/react-flow-docs), or click the "edit this page” button that lives on every doc site.
All interactions should be done with care following our [Code of Conduct](https://github.com/wbkd/react-flow/blob/main/CODE_OF_CONDUCT.md).
## Enhancements
If you have an idea or suggestion for an enhancement to the React Flow library, please use the [New Features](https://github.com/wbkd/react-flow/discussions/categories/new-features) discussion section. If you want to build it yourself, **please reach out to us before you dive into a new pull request.** The direction of React Flow and which new features are added are discussed in our Discord Server and in [this Github discussions section](https://github.com/wbkd/react-flow/discussions/categories/new-features), and in the end they are decided by the core team.
Talking to us first about the enhancement you want to build will be the most likely way to get your pull request into the library (see Our Contributing Philosophy above). We would hate to see you write code youre proud of, just to learn that weve already been working on the same thing, or that we feel doesnt fit into the core library.
### Contact us
To ask about a possible enhancement, email us at info@reactflow.dev
### 💫 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.