CONTRIBUTING.md 2.5KB
Contributing to Node-RED-Dashboard
We welcome contributions, but request you follow these guidelines.
This project adheres to the Contributor Covenant 1.4. By participating, you are expected to uphold this code. Please report unacceptable behaviour to any of the project’s core team.
Raising issues
Please raise any bug reports on the relevant project’s issue tracker. Be sure to search the list to see if your issue has already been raised.
A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong.
Provide as much context as possible so we can try to recreate the issue. If possible, include the relevant part of your flow. To do this, select the relevant nodes, press Ctrl-E and copy the flow data from the Export dialog.
At a minimum, please include:
- Version of Node-RED-Dashboard - either release number if you downloaded a zip, or the first few lines of
git logif you are cloning the repository directly.- Version of Node-RED - either release number if you downloaded a zip, or the first few lines of
git logif you are cloning the repository directly. - Version of node.js - what does
node -vsay?
- Version of Node-RED - either release number if you downloaded a zip, or the first few lines of
Feature requests
For feature requests, please raise them on the mailing list.
Pull-Requests
If you want to raise a pull-request with a new feature, or a refactoring of existing code, it may well get rejected if you haven’t discussed it on the mailing list first.
Contributor License Agreement
All contributors need to sign the JS Foundation’s Contributor License Agreement. It is an online process and quick to do. You can read the details of the agreement here: https://cla.js.foundation/node-red/node-red.
If you raise a pull-request without having signed the CLA, you will be prompted to do so automatically.
Coding standards
Please ensure you follow the coding standards used through-out the existing code base. Some basic rules include:
- indent with 4-spaces, no tabs. No arguments.
- opening brace on same line as
if/for/functionand so on, closing brace on its own line. - There are .jshintrc and .jscsrc files included in the project which should be used to help formatting.