Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
knolleary committed Feb 6, 2015
1 parent 86c8a5d commit d1fe997
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 36 deletions.
47 changes: 18 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.





Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,22 @@ Check out [INSTALL](INSTALL.md) for full instructions on getting started.
4. node red.js
5. Open <https://localhost:1880>

## Documentation
## Getting Help

More documentation can be found [here](https://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

Expand All @@ -48,4 +47,4 @@ For more open-source projects from IBM, head over [here](https://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).

0 comments on commit d1fe997

Please sign in to comment.