From d1fe997bf7abc1ed624c9b367e854ba4e459c837 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Fri, 6 Feb 2015 13:16:46 +0000 Subject: [PATCH] Doc updates --- CONTRIBUTING.md | 47 ++++++++++++++++++----------------------------- README.md | 13 ++++++------- 2 files changed, 24 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e1933614..f260ea859 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,11 @@ 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) + ## Raising issues Please raise any bug reports on the project's @@ -21,43 +26,16 @@ At a minimum, please include: - Version of node.js - what does `node -v` say? -## New features +## Feature requests For feature requests, please raise them on the [mailing list](https://groups.google.com/forum/#!forum/node-red). ## Pull-Requests -### Changes to existing code -if you want to raise a pull-request with a new feature, or a refactoring +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. -### 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. - -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. - -### 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`/etc, closing brace on its - own line. - ### Contributor License Agreement In order for us to accept pull-requests, the contributor must first complete @@ -74,6 +52,17 @@ You can download the CLAs here: 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`/etc, closing brace on its + own line. + + diff --git a/README.md b/README.md index aeb7c03f0..614afc2f4 100644 --- a/README.md +++ b/README.md @@ -19,23 +19,22 @@ Check out [INSTALL](INSTALL.md) for full instructions on getting started. 4. node red.js 5. Open -## Documentation +## Getting Help More documentation can be found [here](http://nodered.org/docs). -For further help, or general discussion, there is also a [mailing list](https://groups.google.com/forum/#!forum/node-red). +For further help, or general discussion, please use the [mailing list](https://groups.google.com/forum/#!forum/node-red). ## Browser Support The Node-RED editor runs in the browser. We routinely develop and test using -Chrome and Firefox. We have anecdotal evidence that it works in IE9. +Chrome and Firefox. We have anecdotal evidence that it works in recent versions of IE. -We do not yet support mobile browsers, although that is high on our priority -list. +We have basic support for using in mobile/tablet browsers. ## Contributing -Please see our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md). +Before raising a pull-request, please read our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md). ## Authors @@ -48,4 +47,4 @@ For more open-source projects from IBM, head over [here](http://ibm.github.io). ## Copyright and license -Copyright 2013, 2014 IBM Corp. under [the Apache 2.0 license](LICENSE). +Copyright 2013, 2015 IBM Corp. under [the Apache 2.0 license](LICENSE).