Skip to content

Commit

Permalink
rest fix
Browse files Browse the repository at this point in the history
  • Loading branch information
TheChymera committed Feb 15, 2023
1 parent 3514637 commit 2861de4
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Files organization
* `heudiconv/ <./heudiconv>`_ is the main Python module where major development is happening, with
major submodules being:

* ``cli/`` - wrappers and argument parsers bringing the HeuDiConv functionality to the command
- ``cli/`` - wrappers and argument parsers bringing the HeuDiConv functionality to the command
line.
* ``external/`` - general compatibility layers for external functions HeuDiConv depends on.
* ``heuristics/`` - heuristic evaluators for workflows, pull requests here are particularly
- ``external/`` - general compatibility layers for external functions HeuDiConv depends on.
- ``heuristics/`` - heuristic evaluators for workflows, pull requests here are particularly
welcome.

* `docs/ <./docs>`_ - documentation directory.
Expand All @@ -30,30 +30,26 @@ If you are unsure what that means, here is a set-up workflow you may wish to fol
on the “Fork” button near the top of the page — this will create a copy of the repository
writeable by your GitHub user.
1. Set up a clone of the repository on your local machine and connect it to both the “official”
and your copy of the repository on GitHub
and your copy of the repository on GitHub::

.. code-block:: sh
git clone git://github.com/nipy/heudiconv
cd heudiconv
git remote rename origin official
git remote add origin git://github.com/YOUR_GITHUB_USERNAME/heudiconv
git clone git://github.com/nipy/heudiconv
cd heudiconv
git remote rename origin official
git remote add origin git://github.com/YOUR_GITHUB_USERNAME/heudiconv

2. When you wish to start a new contribution, create a new branch:
2. When you wish to start a new contribution, create a new branch::

.. code-block:: sh
git checkout -b topic_of_your_contribution
git checkout -b topic_of_your_contribution

3. When you are done making the changes you wish to contribute, record them in Git:
3. When you are done making the changes you wish to contribute, record them in Git::

.. code-block:: sh
git add the/paths/to/files/you/modified can/be/more/than/one
git commit
git add the/paths/to/files/you/modified can/be/more/than/one
git commit

3. Push the changes to your copy of the code on GitHub, following which Git will
provide you with a link which you can click to initiate a pull request
provide you with a link which you can click to initiate a pull request::

.. code-block:: sh
git push -u origin topic_of_your_contribution
git push -u origin topic_of_your_contribution


(If any of the above seems overwhelming, you can look up the `Git documentation
Expand Down

0 comments on commit 2861de4

Please sign in to comment.