42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# CONTRIBUTING
|
|
|
|
## Code
|
|
|
|
* The code should follow Watson Developer Cloud [coding guidances](https://github.com/watson-developer-cloud/api-guidelines)
|
|
* The code should follow: https://github.com/airbnb/javascript
|
|
* 2 spaces identation
|
|
* `snake_case`
|
|
|
|
## Issues
|
|
|
|
If you encounter an issue with using the labs here, you are welcome to submit
|
|
a [bug report](https://github.com/node-red-contrib-utils/node-red-contrib-media-utils/issues).
|
|
Before that, please search for similar issues. It's possible somebody has already encountered this issue.
|
|
|
|
## Pull Requests
|
|
|
|
If you want to contribute to the repository, follow these steps:
|
|
|
|
1. Fork the repo.
|
|
2. Develop code changes.
|
|
5. Commit your changes.
|
|
6. Push to your fork and submit a pull request.
|
|
|
|
### Getting started
|
|
|
|
* Install [Node-RED](http://nodered.org/)
|
|
* Fork [this repo](https://github.com/node-red-contrib-utils/node-red-contrib-media-utils)
|
|
* Clone the project
|
|
* Create an npm link to your forked project
|
|
* Within the cloned directory, run `npm link`
|
|
* Within the Node-RED directory, run `npm link node-red-contrib-media-utils`
|
|
* Run Node-RED
|
|
|
|
Now you should have the media nodes installed in your local palette, allowing you to work on your project locally.
|
|
|
|
### Modify or Create new nodes
|
|
|
|
If you want to add a node, create a folder using the same naming convention.
|
|
|
|
Please refer to the [Node-RED](http://nodered.org/docs/creating-nodes/) documentation.
|