Advice for developers

[pp-mo]

Iris could still do with a bit more information to help people contribute painlessly
It could be really short, but should enable people to..

• get started without frustration
• avoid in advance problems with submissions, and wasting effort that needs to be re-done
• have a simple reference checklist for the submissions process

Especially handy:

• explanation of how to run the 'standard' tests
  • how to run all the tests, plus doctests and extests
  • install the test-data
  • what additional installs may be required (we aren't quite there yet, as some tests still depend on optional installs )
• recommended list of optional installs that should be included :
  • E.G. the gribapi for a start
• notes on conventions. I.E., beyond pep8/244/257, mostly just some naming conventions.
• simple checklist of what to get sorted before making a PR

[bblay]

👍

[pp-mo]

See also : https://groups.google.com/forum/#!topic/scitools-iris-dev/FXytreiat8M

@cpelley attempting to write a submissions guide, something like above suggestions.
I just added a note about the sources of our style rules.

[pp-mo]

Mostly dealt with now.
The "how to run the tests" may still be relevant : see #3453