Skip to content
This repository was archived by the owner on Apr 18, 2018. It is now read-only.

Commit 738a1b5

Browse files
edoddridgejahn
authored andcommitted
add a contributing section to the docs
This section outlines how one can contribute to the MITgcm project, provides instructions, and describes the code style used in this project.
1 parent b627895 commit 738a1b5

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

doc/contributing.rst

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
.. _chap_contributing:
2+
3+
Contributing to the MITgcm
4+
**************************
5+
6+
The MITgcm is an open source project that relies on the participation of its users, and we welcome contributions. This chapter sets out how you can contribute to the MITgcm.
7+
8+
9+
Bugs and feature requests
10+
=========================
11+
12+
If you think you've found a bug, the best thing to check that you're using the latest version of the model. If the bug is still in the latest version, then think about how you might fix it and file a ticket in the GitHub issue tracker [url to be inserted once we have the proper repo]. Please include as much detail as possible. At a minimum your ticket should include:
13+
14+
- what the bug does;
15+
- the location of the bug: file name and line number(s); and
16+
- any suggestions you have for how it might be fixed.
17+
18+
To request a new feature, or guidance on how to implement it yourself, please open a ticket with the following details:
19+
20+
- a clear explanation of what the feature will do; and
21+
- a summary of the equations to be solved.
22+
23+
24+
25+
Contributing to the code
26+
========================
27+
28+
To contribute to the source code of the model you will need to fork the repository and place a pull request on GitHub. The two following sections describe this process in different levels of detail. If you are unfamiliar with git, you may wish to skip the Quickstart guide and use the detailed instructions. All contributions are expected to conform with the :ref:`subsec_code_style_guide`.
29+
30+
31+
Quickstart Guide
32+
----------------
33+
34+
35+
36+
Detailed guide
37+
--------------
38+
39+
40+
.. _subsec_code_style_guide:
41+
42+
Style guide
43+
-----------
44+
45+
46+
47+
Contributing to the manual
48+
==========================
49+
50+
51+
52+
Quickstart Guide
53+
----------------
54+
55+
56+
57+
Detailed guide
58+
--------------
59+
60+
61+
.. _subsec_manual_style_guide:
62+
63+
Style guide
64+
----------------------

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ Welcome to MITgcm's user manual
1515
phys_pkgs/phys_pkgs
1616
getting_started/getting_started
1717
examples/examples
18+
contributing
1819
zreferences

0 commit comments

Comments
 (0)