Skip to content

Commit

Permalink
fix code block syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
davidism committed Jun 18, 2023
1 parent 372b8e3 commit e81bcc5
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,9 +224,9 @@ instructions.
"release-A.B.C". For a fix release, branch off the corresponding release branch. For
a feature release, branch off of main.

```
$ git switch -c release-A.B.C A.B.x
```
.. code-block:: text
$ git switch -c release-A.B.C A.B.x
2. Review the ``CHANGES.rst`` file and ensure each code change has a corresponding
entry. Only code changes need entries, not docs or non-published code and files. Use
Expand All @@ -239,9 +239,9 @@ instructions.

5. Commit with a standard message:

```
$ git commit -am 'release version A.B.C'
```
.. code-block:: text
$ git commit -am 'release version A.B.C'
6. Push the branch and open a PR. The title should be the same as the commit message
(if there was only one commit). No need to add a description. Assign it to the
Expand All @@ -255,10 +255,10 @@ instructions.
8. Create and push an annotated tag with a standard message. You'll see the new
"build" workflow status get added to the PR checks.

```
$ git tag -am 'release version A.B.C' A.B.C
$ git push origin A.B.C
```
.. code-block:: text
$ git tag -am 'release version A.B.C' A.B.C
$ git push origin A.B.C
9. Wait for the "build", "provenance", and "create-release" workflows to succeed. Go
into the created draft release and check that the expected files (with the correct
Expand All @@ -277,22 +277,22 @@ instructions.

12. If this was a fix release, merge it into main now that the PR is merged.

```
$ git switch A.B.x
$ git pull
$ git switch main
$ git merge A.B.x
$ git push
```
.. code-block:: text
$ git switch A.B.x
$ git pull
$ git switch main
$ git merge A.B.x
$ git push
12. If this was a feature release, make a new branch for fix releases.

```
$ git switch main
$ git pull
$ git switch -c A.B.x
$ git push
```
.. code-block:: text
$ git switch main
$ git pull
$ git switch -c A.B.x
$ git push
13. If this was a feature release, ask a maintainer with docs access to update Read the
Docs to use the new branch as the primary.

0 comments on commit e81bcc5

Please sign in to comment.