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

Commit 7085fdb

Browse files
committed
changed ordering/section labels as per discussion
1 parent 46dda88 commit 7085fdb

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

doc/contributing.rst

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ To request a new feature, or guidance on how to implement it yourself, please op
2222

2323

2424

25-
Contributing to the code
25+
Using Git and Github
2626
========================
2727

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`.
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:`sec_code_style_guide`.
2929

3030

3131
Quickstart Guide
@@ -185,13 +185,15 @@ A detailed explanation of steps for contributing MITgcm code edits:
185185

186186
% git push -u origin bugfix
187187

188-
7. Finally create a “pull request” (a.k.a. “PR”; in other words, you are requesting that the maintainers pull your changes into the main code repository). In GitHub, go to the fork of the project that you made (https://github.com/user_name/MITgcm.git). There is a button for "Compare and Pull" in your newly created branch. Click the button! Now you can add a final succinct summary description of what you've done in your commit(s), and flag up any issues. At last the maintainers will be notified and be able to peruse your changes! While the PR remains open, you can go back to step #5 and make additional edits, git adds, git commits, and then redo step #6; such changes will be added to the PR (and maintainers re-notified). The pull request remains open until either the maintainers fully accept and merge your code changes into the main repository, or decide to reject your changes. But much more likely than the latter, you will instead be asked to respond to feedback, modify your code changes in some way, and/or clean up your code to better satisfy our style requirements, etc., and the pull request will remain open instead of outright rejection.
188+
7. Finally create a “pull request” (a.k.a. “PR”; in other words, you are requesting that the maintainers pull your changes into the main code repository). In GitHub, go to the fork of the project that you made (https://github.com/user_name/MITgcm.git). There is a button for "Compare and Pull" in your newly created branch. Click the button! Now you can add a final succinct summary description of what you've done in your commit(s), and flag up any issues. At last the maintainers will be notified and be able to peruse your changes! While the PR remains open, you can go back to step #5 and make additional edits, git adds, git commits, and then redo step #6; such changes will be added to the PR (and maintainers re-notified).
189189

190+
Your pull request remains open until either the maintainers fully accept and merge your code changes into the main repository, or decide to reject your changes. But much more likely than the latter, you will instead be asked to respond to feedback, modify your code changes in some way, and/or clean up your code to better satisfy our style requirements, etc., and the pull request will remain open instead of outright rejection. It is possible for other users (besides the maintainers) to examine or even download your pull request; see :ref:`sec_pullreq`.
190191

191-
.. _subsec_code_style_guide:
192192

193-
Coding Style guide
194-
------------------
193+
.. _sec_code_style_guide:
194+
195+
Coding style guide
196+
==================
195197

196198
**Detailed instructions or link to be added.**
197199

@@ -202,25 +204,6 @@ The MITgcm uses the continuous integration service Travis-CI to test code before
202204

203205
**Detailed instructions or link to be added.**
204206

205-
Reviewing pull requests
206-
-----------------------
207-
208-
The only people with write access to the main repository are a small number of core MITgcm developers. They are the people that will eventually merge your pull requests. However, before your PR gets merged, it will undergo the automated testing on Travis-CI, and it will be assessed by the MITgcm community.
209-
210-
**Everyone can review and comment on pull requests.** Even if you are not one of the core developers you can still comment on a pull request.
211-
212-
To test pull requests locally you should:
213-
214-
- add the repository of the user proposing the pull request as a remote, :code:`git remote add user_name https://github.com/user_name/MITgcm.git` where user_name is replaced by the user name of the person who has made the pull request;
215-
216-
- download a local version of the branch from the pull request, :code:`git fetch user_name` followed by :code:`git checkout --track user_name/foo`;
217-
218-
- run tests locally; and
219-
220-
- possibly push fixes or changes directly to the pull request.
221-
222-
None of these steps, apart from the final one, require write access to the main repository. This means that anyone can review pull requests. However, unless you are one of the core developers you won't be able to directly push changes. You will instead have to make a comment describing any problems you find.
223-
224207

225208
Contributing to the manual
226209
==========================
@@ -310,5 +293,26 @@ This information should go in an 'adominition' block. The source code to achieve
310293

311294
:math:`S_y`: **SlopeY** (argument on exit)
312295

296+
.. _sec_pullreq:
297+
298+
Reviewing pull requests
299+
=======================
300+
301+
The only people with write access to the main repository are a small number of core MITgcm developers. They are the people that will eventually merge your pull requests. However, before your PR gets merged, it will undergo the automated testing on Travis-CI, and it will be assessed by the MITgcm community.
302+
303+
**Everyone can review and comment on pull requests.** Even if you are not one of the core developers you can still comment on a pull request.
304+
305+
To test pull requests locally you should:
306+
307+
- add the repository of the user proposing the pull request as a remote, :code:`git remote add user_name https://github.com/user_name/MITgcm.git` where user_name is replaced by the user name of the person who has made the pull request;
308+
309+
- download a local version of the branch from the pull request, :code:`git fetch user_name` followed by :code:`git checkout --track user_name/foo`;
310+
311+
- run tests locally; and
312+
313+
- possibly push fixes or changes directly to the pull request.
314+
315+
None of these steps, apart from the final one, require write access to the main repository. This means that anyone can review pull requests. However, unless you are one of the core developers you won't be able to directly push changes. You will instead have to make a comment describing any problems you find.
316+
313317

314318

0 commit comments

Comments
 (0)