Skip to content

Commit 9c4c64c

Browse files
Jeffery Scottjahn
authored andcommitted
manual conversion, chapter 1
1 parent 88211f5 commit 9c4c64c

37 files changed

+1513
-373
lines changed

doc/contributing.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,36 @@ To contribute to the source code of the model you will need to fork the reposito
3030

3131
Quickstart Guide
3232
----------------
33+
34+
1: Fork the project on Github (using the fork button) and create a local clone, if you haven’t already:
35+
**git clone https://github.com/user_name/MITgcm66h.git**
36+
37+
2: Move into your local clone directory (cd MITgcm66h) and and set up a remote that points to the original:
38+
**git remote add upstream https://github.com/altMITgcm/MITgcm66h.git**
39+
40+
3: checkout the master branch and sync everywhere:
41+
**git checkout master**
42+
**git pull upstream master**
43+
**git push origin master**
44+
45+
4: Make a new branch (name it something appropriate, here assuming a bugfix) and make edits on this branch:
46+
**git checkout -b bugfix**
47+
48+
5: When edits are done, do all **git add**s and **git commit**. In the commit, make a succinct (<70 char) summary, followed by a blank line and a longer description. Reference any outstanding issues addressed using the syntax **#ISSUE_NUMBER <#>**.
49+
50+
6: Push the edited branch to the origin remote (i.e. your fork) on github:
51+
**git push -u origin bugfix**
52+
53+
7. On github, go to your fork and hot the pull request (PR) button, and wait for the MITgcm head developers to review your proposed changes.
54+
You may get additional questions or requests before your changes are accepted into the primary MITgcm source code.
55+
56+
57+
Detailed Guide for those less familiar with Git and Github
58+
----------------------------------------------------------
59+
60+
What is Git? Git is the version control system used to maintain the MITgcm, coordinating work among the many model contributors, and tracking changes in model code.
61+
If you are familiar with the older form of version control used by the MITgcm (CVS), there are many similarities, but we now take advantage of the modern capabilities offered by Git.
62+
3363
You will need a GitHub account, but that's pretty much it!
3464

3565
1: Fork the project and create a local clone (copy)

0 commit comments

Comments
 (0)