Просмотр исходного кода

add development branches information

theshka 9 лет назад
Родитель
Сommit
7a1af40337
1 измененных файлов с 13 добавлено и 0 удалено
  1. 13 0
      _plugin-dev/basics.md

+ 13 - 0
_plugin-dev/basics.md

@@ -3,6 +3,7 @@ toc:
     basics:
         _title: Basics
         versioning: Versioning
+        branches: Branches
         build--release: Build & Release
 nav: 1
 ---
@@ -23,6 +24,18 @@ Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increme
 
 For more information see the [http://semver.org](http://semver.org) website.
 
+# Branches
+The `master` branch contains the current development version of Pico,
+*it is likely unstable and __not ready__ for production use*.
+
+When creating a new development branch, please follow this prefixing convention:
+
+- `feature/` for bigger features,
+- `enhancement/` for smaller improvements, and
+- `bugfix/` for bug fixes.
+
+As soon as development reaches a point where feedback is appreciated, a PR is opened. After some time (very soon for bug fixes, and other improvements should have a reasonable feedback phase) the PR is merged into `master` and the development branch can be deleted.
+
 # Build & Release
 Defined below is a specification to which the Build and Release process of Pico should follow. We use `travis-ci` to automate the process, and each commit to `master` should be releasable.