Skip to content

Commit

Permalink
DOC: Move Git branches description into main docs
Browse files Browse the repository at this point in the history
Add a description of the branches to the main contributing guide.

Remove the Maintenance/Introduction.md where branch descriptions were
kept because it also had redundant, outdated information on
contributing.
  • Loading branch information
thewtex committed Nov 17, 2023
1 parent 7d27bd1 commit db4b1d2
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 53 deletions.
53 changes: 0 additions & 53 deletions Documentation/Maintenance/Introduction.md

This file was deleted.

20 changes: 20 additions & 0 deletions Documentation/docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,26 @@ To connect your [ORCID](https://orcid.org/) profile to the [ITK Zenodo
citation](https://zenodo.org/record/3592082), add your name and ORCID iD to
the *ITK/.zenodo* file after contributing 10 or more commits.

Branches
--------

At the time of this writing the `ITK` repository has the following
branches:

* `master`: Development (default)
* `release`: Maintenance of latest release
* `release-3.20`: Maintenance of the ITKv3 series
* `release-4.13`: Maintenance of the ITKv4 series
* `5.4`: Maintenance of the ITKv5 series.
- The naming convention changed to support ReadTheDocs rendering of
versions on docs.itk.org
- Future releases, `6.0`, `6.1`, etc. should use this convention.
* `nightly-master`: Follows master, updated at 01:00 UTC for nightly dashboard build consistency.
* `hooks`: Local commit hooks (place in `.git/hooks`)
* `dashboard`: Dashboard script (setup a CDash client)

Actual releases have tags named by the release version number.

```{toctree}
:hidden:
:maxdepth: 3
Expand Down

0 comments on commit db4b1d2

Please sign in to comment.