From 04fe16be7da68d5a453a2ffdb9c6c709fb132f2f Mon Sep 17 00:00:00 2001 From: Bill Ladwig Date: Fri, 18 Jan 2019 11:25:20 -0700 Subject: [PATCH] Added stubs --- doc/source/contrib.rst | 63 ++++++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 1 - 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 doc/source/contrib.rst diff --git a/doc/source/contrib.rst b/doc/source/contrib.rst new file mode 100644 index 0000000..e5621ff --- /dev/null +++ b/doc/source/contrib.rst @@ -0,0 +1,63 @@ +.. _contrib_guide: + +Contributor Guide +================================= + +.. note:: + + This contributor guide is written for wrf-python v1.3.x. In the + not-too-distant future, wrf-python will undergo a significant refactoring + to remove the wrapt decorators (which don't serialize for dask), but the + concepts will remain the same as described below. + + +Ways to Contribute +----------------------------- + +Users are encouraged to contribute various ways. This includes: + +- Submitting a bug report +- Submitting bug fixes +- Submitting new Fortran computational routines +- Submitting new Python computational routines +- Submitting fully wrapped computational routines + + +Getting the source code +------------------------------ + +The source code is available on GitHub: + + https://github.com/NCAR/wrf-python + +To checkout the code:: + + git clone https://github.com/NCAR/wrf-python + + +Git Flow +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This project follows the GitFlow Workflow, which you can read about here if it +is new to you: + +https://leanpub.com/git-flow/read + +When you first clone the repository, by default you will be on the 'develop' +branch, which is what you should use for your development. + + +Pull Requests +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In order to submit changes, you must use GitHub to issue a pull request. + + +Overview of WRF-Python Internals +---------------------------------- + +WRF-Python is a collection of diagnostic and interpolation routines for WRF-ARW +data. The API consists of a handful of functions + + + diff --git a/doc/source/index.rst b/doc/source/index.rst index da1b8e2..7b9fe01 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -53,7 +53,6 @@ Documentation ./api ./faq ./support - ./contrib ./citation ./license ./tutorial