Skip to content

Add documentation about how to contribute #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/source/contribute.rst
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/ODM2/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
<http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`__.
- 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 <https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods>`__
for discussion of class vs instance methods.
- Provide link to `Controlled Vocabulary <http://vocabulary.odm2.org/>`__
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 <https://github.com/ODM2/ODM2PythonAPI/issues/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.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ A Python-based application programmer's interface for the `Observations Data Mod
modules
odm2models
credits
contribute

Indices and tables
==================
Expand Down