Skip to content

Commit

Permalink
DOC: document branching mechanism
Browse files Browse the repository at this point in the history
fixes #650
  • Loading branch information
Sebastian Wagner committed Jun 14, 2017
1 parent fdd27c6 commit 0cf87d8
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/Developers-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,10 +239,18 @@ Any component of IntelMQ MUST respect the "Data Harmonization Ontology".

* The main repository is in [github.com/certtools/intelmq](https://github.com/certtools/intelmq).
* There are a couple of forks which might be regularly merged into the main repository. They are independent and can have incompatible changes and can deviate from the upstream repository.
* The "master" branch is the current development branch for the next feature release. Releases are tagged as release branch together with release branches for bugfixes and bugfix releases.
* We use [semantic versioning](http://semver.org/).
* Releases shall receive non-breaking bug fixes. The "master" branch can change and might introduce non-compatible changes.
* If you contribute something, please fork the repository and create a separate branch and use this for pull requests, see section below.
* We use [semantic versioning](http://semver.org/). A short summary:
* a.x are stable releases
* a.b.x are bugfix/patch releases
* a.x must be compatible to version a.0 (i.e. API/Config-compatibility)
* If you contribute something, please fork the repository, create a separate branch and use this for pull requests, see section below.

### Branching model

* "master" is the stable branch. It hold the latest stable release. Non-developers should only work on this branch. The recommended log level is WARNING. Code is only added by merges from the maintenance branches.
* "maintenance/a.b.x" branches accumulate (cherry-picked) patches for a maintenance release (a.b.x). Recommended for experienced users which deploy intelmq themselves. No new features will be added to these branches.
* "develop" is the development branch for the next stable release (a.x). New features must go there. Developers may want to work on this branch. This branch also holds all patches from maintenance releases if applicable. The recommended log level is DEBUG.
* Separate branches to develop features or bug fixes may be used by any contributor.

### How to Contribute

Expand Down

0 comments on commit 0cf87d8

Please sign in to comment.