Skip to content

Commit 96249ec

Browse files
authored
Merge pull request #113 from lsetiawan/contrib
> Add documentation about how to contribute Looks good. I'm merging.
2 parents e3f5db6 + fef970e commit 96249ec

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/source/contribute.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Contribute to Documentation
2+
============================
3+
4+
This guide is a reference on how to contribute to ODM2 Documentation effort
5+
for the many `ODM2 Software Ecosystem <https://github.com/ODM2/odm2-software-ecosystem>`__.
6+
7+
Conventions
8+
-----------
9+
10+
There are a few conventions that should be followed
11+
when writing docstrings within the code:
12+
13+
- Docstrings should follow `Google Style Documentation
14+
<http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`__.
15+
- Do not say "**defaults to ____**" for any arguments,
16+
unless the argument needs further explanation.
17+
The default value is already available in the method/function definition.
18+
- If function needs to be instantiated, explicitly show in example. See
19+
`here <https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods>`__
20+
for discussion of class vs instance methods.
21+
- Provide link to `Controlled Vocabulary <http://vocabulary.odm2.org/>`__
22+
if an argument needs a CV as value.
23+
24+
Please add any additional conventions that you think should be in place
25+
within `the github issue #106 <https://github.com/ODM2/ODM2PythonAPI/issues/106>`__.
26+
27+
Pull requests
28+
-------------
29+
30+
Once changes has been in place within your forked copy of the repository
31+
you are working on, please create a pull request to add your contribution
32+
to the **master** branch of the repository.

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ A Python-based application programmer's interface for the `Observations Data Mod
1111
modules
1212
odm2models
1313
credits
14+
contribute
1415

1516
Indices and tables
1617
==================

0 commit comments

Comments
 (0)