Skip to content

Commit 7acad29

Browse files
committed
Minor documentation adjustment.
1 parent 747af31 commit 7acad29

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/developer.contributing.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ When making a new release of Gambit, follow these steps:
158158
2. Update the version number in the ``GAMBIT_VERSION`` file at the root of the repository to ``X.Y.Z``.
159159

160160
All other files will automatically use the updated version number:
161-
161+
162162
- `pyproject.toml` reads from GAMBIT_VERSION file at build time
163163
- `configure.ac` reads from GAMBIT_VERSION file and substitutes into `Info.plist` and `gambit.wxs`
164164
- `src/pygambit/__init__.py` reads from installed package metadata or GAMBIT_VERSION file
@@ -168,18 +168,18 @@ When making a new release of Gambit, follow these steps:
168168
3. Update the `ChangeLog` file with a summary of changes
169169

170170
4. Once there are no further commits to be made for the release, create a tag for the release from the latest commit on the maintenance branch. ::
171-
171+
172172
git tag -a vX.Y.Z -m "Gambit version X.Y.Z"
173173

174174
5. Push the maintenance branch and tags to the GitHub repository. ::
175-
175+
176176
git push origin maintX_Y
177177
git push origin --tags
178178

179179
6. Create a new release on the `GitHub releases page <https://github.com/gambitproject/gambit/releases>`__, using the tag created in step 4.
180180
Include a summary of changes from the `ChangeLog` file in the release notes.
181181

182-
7. Currently there is no automated process for pushing the new release to PyPI. This must be done manually by Ted Turocy or Rahul Savani.
182+
7. Currently there is no automated process for pushing the new release to PyPI. This must be done manually.
183183

184184
.. TODO: update this process to be automated via GitHub Actions: Issue #557
185185
@@ -191,4 +191,4 @@ If you have bug fixes that should be applied across maintained versions:
191191
1. Make a branch from the oldest maintenance branch to which the change applies
192192
2. Apply the change and make a pull request to that maintenance branch
193193
3. After the pull request is merged, open new pull requests to each subsequent maintenance branch and finally to the master branch, merging each in turn
194-
4. Create new releases from each maintenance branch as needed, following the steps in :ref:`making-a-new-release`.
194+
4. Create new releases from each maintenance branch as needed, following the steps in :ref:`making-a-new-release`.

0 commit comments

Comments
 (0)