Skip to content

Commit

Permalink
added description of branches and tags to the development doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jgabler-hpc committed Jan 15, 2025
1 parent c1112aa commit 03cf717
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions doc/markdown/manual/development-guide/00_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Introduction

This guide is intended for developers who want to contribute to the ClusterScheduler project.
It provides an overview of the project structure, the development process, and the tools used in the project.

# Contributing to the ClusterScheduler Project

@todo how to contribute to the project (fork, branch, pull request, ...)

# Tags and Branches

## Tags

Whenever we release a stable version we create a tag in the git repository.
Version numbers consist of three parts: major, minor, and patch, e.g. `9.0.0`.
The tag is named after the version number, e.g. `V900_TAG`.
Pre-releases might also be tagged, e.g. `V900alpha1_TAG`.

## Branches

The `master` branch is the main development branch.
It is used for the development of new features and bug fixes.
When we start working on features for a new major or minor release we will create a new branch
for the maintenance of the current release, e.g. a `V90_BRANCH` for the maintenance of
`9.0.x` versions when we start developmment on `9.1.0`.

## Existing Tags and Branches of the ClusterScheduler Project

Private branches and feature specific branches might be created by developers for their work.
They will not be described here.

Tags and branches before `V9` will also not be described here.

| Branch | Tag | Description |
|:---------------|:------------|:------------------------------------------------------------------------|
| master | | main development branch |
| | V900_TAG | first OCS/GCS release |
| | V901_TAG | first 9.0 patch |
| | V902_TAG | second 9.0 patch |
| | | |
| V900_BRANCH | | maintenance of 9.0.0 |
| | V900p1_TAG | patch to the 9.0.0 making it work on GCP (CS-663) |

0 comments on commit 03cf717

Please sign in to comment.