diff --git a/.jshintrc b/.jshintrc index 8272ad00..db63befe 100644 --- a/.jshintrc +++ b/.jshintrc @@ -1,8 +1,4 @@ { - "predef": [ "RED" ], - "node": true, - "browser": true, - "jquery": true, "asi": true, // allow missing semicolons "curly": true, // require braces "eqnull": true, // ignore ==null @@ -10,9 +6,9 @@ "immed": true, // require immediate functions to be wrapped in ( ) "nonbsp": true, // warn on unexpected whitespace breaking chars //"strict": true, // commented out for now as it causes 100s of warnings, but want to get there eventually - //"unused": true, // Check for unused functions and variables + //"unused": true, // Check for unused functions and variables "loopfunc": true, // allow functions to be defined in loops //"expr": true, // allow ternery operator syntax... "sub": true, // don't warn that foo['bar'] should be written as foo.bar - "undef": true // warn about undefined variables + "proto": true // allow setting of __proto__ in node < v0.12 } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..cec0e825 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contributing to Node-RED + +We welcome contributions, but request you follow these guidelines. + + - [Raising issues](#raising-issues) + - [Feature requests](#feature-requests) + - [Pull-Requests](#pull-requests) + - [Contributor License Agreement](#contributor-license-agreement) + +This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/). +By participating, you are expected to uphold this code. Please report unacceptable +behavior to any of the [project's core team](https://github.com/orgs/node-red/teams/core). + +## 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 - either release number if you downloaded a zip, or the first few lines of `git log` if you are cloning the repository directly. + - Version of node.js - what does `node -v` say? + +## Feature requests + +For feature requests, please raise them on the [mailing list](https://groups.google.com/forum/#!forum/node-red). + +## 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](https://groups.google.com/forum/#!forum/node-red) first. + +### Contributor License Agreement + +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. + +You can download the CLAs here: + + - [individual](http://nodered.org/cla/node-red-cla-individual.pdf) + - [corporate](http://nodered.org/cla/node-red-cla-corporate.pdf) + +If you are an IBMer, please contact us directly as the contribution process is +slightly different. + +### Coding standards + +Please ensure you follow the coding standards used through-out the existing +code base. Some basic rules include: + + - all files must have the Apache license in the header. + - indent with 4-spaces, no tabs. No arguments. + - opening brace on same line as `if`/`for`/`function` and so on, closing brace + on its own line. + - There are .jshintrc and .jscsrc files included in the project which may help diff --git a/README.md b/README.md index 21962e7d..6336cabc 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ To manually install using this repo: ## Contributing -Now that we support npm installaton of nodes we recommend people post their own +Now that we support npm installation of nodes we recommend people post their own nodes via [npm](https://www.npmjs.org/). Please read the [packaging guide notes](http://nodered.org/docs/creating-nodes/packaging.html). @@ -39,12 +39,16 @@ before doing so. ## Copyright and license -Copyright 2013, 2015 IBM Corp. under [the Apache 2.0 license](LICENSE). +Copyright 2013, 2016 IBM Corp. under [the Apache 2.0 license](LICENSE). # Extra Node Information **NPM name** - *File-link* - Description +### Misc + +**N/A** - *[99-sample](./)* - A sample node with more comments than most to try to help you get started without any other docs... + ### Analysis **node-red-node-wordpos** - *[72-wordpos](analysis/wordpos)* - Analyses the payload and classifies the part-of-speech of each word. The resulting message has msg.pos added with the results. A word may appear in multiple categories (eg, 'great' is both a noun and an adjective). @@ -156,7 +160,3 @@ Copyright 2013, 2015 IBM Corp. under [the Apache 2.0 license](LICENSE). **node-red-node-exif** - *[94-exif](utility/exif)* - Extracts GPS and other EXIF information from a passed in jpeg image, **node-red-node-daemon** - *[daemon](utility/daemon)* - starts up (calls) a long running system program and pipes STDIN, STDOUT and STDERR to and from that process. Good for monitoring long running command line applications, - -### Misc - -**N/A** - *[99-sample](./)* - A sample node with more comments than most to try to help you get started without any other docs...