ソースを参照

add travis-ci information

theshka 9 年 前
コミット
34911fc84c
1 ファイル変更17 行追加9 行削除
  1. 17 9
      _plugin-dev/basics.md

+ 17 - 9
_plugin-dev/basics.md

@@ -3,18 +3,16 @@ toc:
     basics:
     basics:
         _title: Basics
         _title: Basics
         versioning: Versioning
         versioning: Versioning
-        build_&_release: Build & Release
+        build--release: Build & Release
 nav: 1
 nav: 1
 ---
 ---
 
 
 # Basics
 # Basics
 Creating your own content for Pico is *easy*.
 Creating your own content for Pico is *easy*.
 
 
-Inside the root Pico folder, all *themes* reside in the `themes` directory,
-and all *plugins* in the `plugins` directory. (As a developer, you may have
-changed these paths and/or directory names when you initialized Pico.)
+Inside the root Pico folder, all *themes* reside in the `themes` directory, and all *plugins* in the `plugins` directory. (As a developer, you may have changed these paths and/or directory names when you initialized Pico.)
 
 
-Besides this documentation please also refer to our [phpDoc](phpDocumentor/).
+Note that if you are submitting pull requests they should be small (i.e. one feature per request), stick to existing coding conventions and documentation should be updated if required.
 
 
 # Versioning
 # Versioning
 Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
 Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
@@ -26,11 +24,21 @@ Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increme
 For more information see the [http://semver.org](http://semver.org) website.
 For more information see the [http://semver.org](http://semver.org) website.
 
 
 # Build & Release
 # Build & Release
-Defined below is a specification to which the Build and Release process of Pico should follow.
-Each commit to `master` should be releasable, otherwise make use of the `development` branch.
+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.
 
 
 ### Commit phase
 ### Commit phase
+- Commit changes
 - Create & Push Git tag
 - Create & Push Git tag
+- Trigger automatic build process...
+
+Example commit message:
+
+    Pico 1.0.1
+    * [New] ...
+    * [Changed] ...
+
+*Please submit pull-requests with a properly
+formatted commit message/SemVer increase to avoid the need for manual amendments.*
 
 
 ### Analysis phase
 ### Analysis phase
 - Run through `scrutinizer-ci`?
 - Run through `scrutinizer-ci`?
@@ -38,7 +46,7 @@ Each commit to `master` should be releasable, otherwise make use of the `develop
 ### Packaging phase
 ### Packaging phase
 - Run composer locally
 - Run composer locally
 - Create a ZIP archive (so vendor/ is included)
 - Create a ZIP archive (so vendor/ is included)
-- Build documentation, output goes to a new folder in the gh-pages branch
+- Build documentation, output goes to a new folder in the `gh-pages` branch
 
 
 ### Release phase
 ### Release phase
 - Create new Git release at tag
 - Create new Git release at tag
@@ -50,4 +58,4 @@ Each commit to `master` should be releasable, otherwise make use of the `develop
     - Changelog
     - Changelog
 
 
 ### Announcements
 ### Announcements
-- 
+- Where to announce new Pico release?