From 13c122072d7046fe0ff447b905ea3d4b233c01be Mon Sep 17 00:00:00 2001 From: moznion Date: Mon, 21 Nov 2016 17:51:52 +0900 Subject: [PATCH] Add hacking guide for SDK developers --- HACKING.md | 43 +++++++++++++++++++++++++++++++++++++++++++ README.md | 16 +--------------- 2 files changed, 44 insertions(+), 15 deletions(-) create mode 100644 HACKING.md diff --git a/HACKING.md b/HACKING.md new file mode 100644 index 00000000..2a5368a6 --- /dev/null +++ b/HACKING.md @@ -0,0 +1,43 @@ +Hacking guide for SDK developers +== + +First of all +-- + +Please execute `make install-devtool`. + +How to run tests +-- + +Use `make test`. + +How to execute [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) +-- + +Use `make phpcs`. + +How to execute [PHPMD](https://phpmd.org/) +-- + +Use `make phpmd`. + +How to execute them all +-- + +`make` + +Release Flow +-- + +1. Make a git tag (this project uses semantic versioning) +1. Push the tag to origin + +That's all. It will be publish on [composer](https://packagist.org/packages/linecorp/line-bot-sdk) automatically. + +e.g. + +``` +$ git tag 1.2.3 +$ git push origin 1.2.3 +``` + diff --git a/README.md b/README.md index 4fd7934e..16218b14 100644 --- a/README.md +++ b/README.md @@ -184,21 +184,7 @@ Requirements For SDK developers -- -### How to run tests - -Use `make test`. - -### How to execute [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) - -Use `make phpcs`. - -### How to execute [PHPMD](https://phpmd.org/) - -Use `make phpmd`. - -### How to execute them all - -`make` +Please refer [HACKING.md](/HACKING.md). See also --