mirror of
https://github.com/node-red/node-red.git
synced 2025-03-01 10:36:34 +00:00
Add CONTRIBUTING.md
This commit is contained in:
41
README.md
41
README.md
@@ -30,46 +30,7 @@ list.
|
||||
|
||||
## Contributing
|
||||
|
||||
### Reporting issues
|
||||
|
||||
Please raise any bug reports on the project's [issue tracker](https://github.com/node-red/node-red/issues?state=open).
|
||||
Be sure to search the list to see if your issue has already been raised.
|
||||
|
||||
For feature requests, please raise them on the [mailing list](https://groups.google.com/forum/#!forum/node-red)
|
||||
first.
|
||||
|
||||
### Creating new nodes
|
||||
|
||||
The plugin nature of Node-RED means anyone can create a new node to extend
|
||||
its capabilities.
|
||||
|
||||
We want to avoid duplication as that can lead to confusion. Many of our existing
|
||||
nodes offer a starting point of functionality. If they are missing features,
|
||||
we would rather extend them than add separate 'advanced' versions. But the key
|
||||
to that approach is getting the UX right to not lose the simplicity.
|
||||
|
||||
We are also going to be quite selective over what nodes are included in the main
|
||||
repository - enough to be useful, but not so many that new user is overwhelmed.
|
||||
|
||||
To contribute a new node, please raise a pull-request against the
|
||||
`node-red-nodes` repository.
|
||||
|
||||
Eventually, the nodes will be npm-installable, but we're not there yet. We'll
|
||||
also have some sort of registry of nodes to help with discoverability.
|
||||
|
||||
### Pull-Requests
|
||||
|
||||
In order for us to accept pull-requests, the contributor must first complete
|
||||
a Contributor License Agreement (CLA). This clarifies the intellectual
|
||||
property license granted with any contribution. It is for your protection as a
|
||||
Contributor as well as the protection of IBM and its customers; it does not
|
||||
change your rights to use your own Contributions for any other purpose.
|
||||
|
||||
Once you have created a pull-request, we'll provide a link to the appropriate
|
||||
CLA document.
|
||||
|
||||
If you are an IBMer, please contact us directly as the contribution process is
|
||||
slightly different.
|
||||
Please see [CONTRIBUTING.md]
|
||||
|
||||
## Authors
|
||||
|
||||
|
Reference in New Issue
Block a user