Skip to content

Commit d1fe997

Browse files
committed
Doc updates
1 parent 86c8a5d commit d1fe997

2 files changed

Lines changed: 24 additions & 36 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
We welcome contributions, but request you follow these guidelines.
44

5+
- [Raising issues](#raising-issues)
6+
- [Feature requests](#feature-requests)
7+
- [Pull-Requests](#pull-requests)
8+
- [Contributor License Agreement](#contributor-license-agreement)
9+
510
## Raising issues
611

712
Please raise any bug reports on the project's
@@ -21,43 +26,16 @@ At a minimum, please include:
2126
- Version of node.js - what does `node -v` say?
2227

2328

24-
## New features
29+
## Feature requests
2530

2631
For feature requests, please raise them on the [mailing list](https://groups.google.com/forum/#!forum/node-red).
2732

2833
## Pull-Requests
2934

30-
### Changes to existing code
31-
if you want to raise a pull-request with a new feature, or a refactoring
35+
If you want to raise a pull-request with a new feature, or a refactoring
3236
of existing code, it may well get rejected if you haven't discussed it on
3337
the [mailing list](https://groups.google.com/forum/#!forum/node-red) first.
3438

35-
### New nodes
36-
37-
The plugin nature of Node-RED means anyone can create a new node to extend
38-
its capabilities.
39-
40-
We want to avoid duplication as that can lead to confusion. Many of our existing
41-
nodes offer a starting point of functionality. If they are missing features,
42-
we would rather extend them than add separate 'advanced' versions. But the key
43-
to that approach is getting the UX right to not lose the simplicity.
44-
45-
To contribute a new node, please raise a pull-request against the
46-
`node-red-nodes` repository.
47-
48-
Eventually, the nodes will be npm-installable, but we're not there yet. We'll
49-
also have some sort of registry of nodes to help with discoverability.
50-
51-
### Coding standards
52-
53-
Please ensure you follow the coding standards used through-out the existing
54-
code base. Some basic rules include:
55-
56-
- all files must have the Apache license in the header.
57-
- indent with 4-spaces, no tabs. No arguments.
58-
- opening brace on same line as `if`/`for`/`function`/etc, closing brace on its
59-
own line.
60-
6139
### Contributor License Agreement
6240

6341
In order for us to accept pull-requests, the contributor must first complete
@@ -74,6 +52,17 @@ You can download the CLAs here:
7452
If you are an IBMer, please contact us directly as the contribution process is
7553
slightly different.
7654

55+
### Coding standards
56+
57+
Please ensure you follow the coding standards used through-out the existing
58+
code base. Some basic rules include:
59+
60+
- all files must have the Apache license in the header.
61+
- indent with 4-spaces, no tabs. No arguments.
62+
- opening brace on same line as `if`/`for`/`function`/etc, closing brace on its
63+
own line.
64+
65+
7766

7867

7968

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,22 @@ Check out [INSTALL](INSTALL.md) for full instructions on getting started.
1919
4. node red.js
2020
5. Open <http://localhost:1880>
2121

22-
## Documentation
22+
## Getting Help
2323

2424
More documentation can be found [here](http://nodered.org/docs).
2525

26-
For further help, or general discussion, there is also a [mailing list](https://groups.google.com/forum/#!forum/node-red).
26+
For further help, or general discussion, please use the [mailing list](https://groups.google.com/forum/#!forum/node-red).
2727

2828
## Browser Support
2929

3030
The Node-RED editor runs in the browser. We routinely develop and test using
31-
Chrome and Firefox. We have anecdotal evidence that it works in IE9.
31+
Chrome and Firefox. We have anecdotal evidence that it works in recent versions of IE.
3232

33-
We do not yet support mobile browsers, although that is high on our priority
34-
list.
33+
We have basic support for using in mobile/tablet browsers.
3534

3635
## Contributing
3736

38-
Please see our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md).
37+
Before raising a pull-request, please read our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md).
3938

4039
## Authors
4140

@@ -48,4 +47,4 @@ For more open-source projects from IBM, head over [here](http://ibm.github.io).
4847

4948
## Copyright and license
5049

51-
Copyright 2013, 2014 IBM Corp. under [the Apache 2.0 license](LICENSE).
50+
Copyright 2013, 2015 IBM Corp. under [the Apache 2.0 license](LICENSE).

0 commit comments

Comments
 (0)