Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.41 KB
Raw

Contributing

Welcome to StatusBay! If you are interested in contributing to the StatusBay code repo then checkout this Contributor's Guide.

For help on how to get started visit our developer guide.

Releases

Versioning

We use standard semver to mark versions.

Publish

The publish of a new release is done with Github Releases for new versions and patches.

The Docker image version is updated automatically in Dockerhub on every release (see statusbay and statusbay-ui).

Branches

We use master branch as the branch for the latest working development version. For stable version please only see releases.

For contributing to StatusBay please follow the next steps:

  1. Create a fork on your branch from master branch
  2. Checkout to your branch using our branch name concentions.
  3. Once done, create a Pull Request following our guide lines. Use the master branch as the target.
  4. For a merge: CI tests must succeed and 1 review from a core maintainer.

Standard branch name conventions (gitflow):

hotfix/your_fix_name
feature/your_feature_name
docs/doc_theme
maintenance/your_change_name