diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst new file mode 100644 index 0000000..5512351 --- /dev/null +++ b/docs/source/contribute.rst @@ -0,0 +1,32 @@ +Contribute to Documentation +============================ + +This guide is a reference on how to contribute to ODM2 Documentation effort +for the many `ODM2 Software Ecosystem `__. + +Conventions +----------- + +There are a few conventions that should be followed +when writing docstrings within the code: + +- Docstrings should follow `Google Style Documentation +`__. +- Do not say "**defaults to ____**" for any arguments, +unless the argument needs further explanation. +The default value is already available in the method/function definition. +- If function needs to be instantiated, explicitly show in example. See +`here `__ +for discussion of class vs instance methods. +- Provide link to `Controlled Vocabulary `__ +if an argument needs a CV as value. + +Please add any additional conventions that you think should be in place +within `the github issue #106 `__. + +Pull requests +------------- + +Once changes has been in place within your forked copy of the repository +you are working on, please create a pull request to add your contribution +to the **master** branch of the repository. diff --git a/docs/source/index.rst b/docs/source/index.rst index 73f5218..c0fc138 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,6 +11,7 @@ A Python-based application programmer's interface for the `Observations Data Mod modules odm2models credits + contribute Indices and tables ==================