Skip to content

Commit 13c1220

Browse files
committed
Add hacking guide for SDK developers
1 parent 7438b25 commit 13c1220

File tree

2 files changed

+44
-15
lines changed

2 files changed

+44
-15
lines changed

HACKING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Hacking guide for SDK developers
2+
==
3+
4+
First of all
5+
--
6+
7+
Please execute `make install-devtool`.
8+
9+
How to run tests
10+
--
11+
12+
Use `make test`.
13+
14+
How to execute [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
15+
--
16+
17+
Use `make phpcs`.
18+
19+
How to execute [PHPMD](https://phpmd.org/)
20+
--
21+
22+
Use `make phpmd`.
23+
24+
How to execute them all
25+
--
26+
27+
`make`
28+
29+
Release Flow
30+
--
31+
32+
1. Make a git tag (this project uses semantic versioning)
33+
1. Push the tag to origin
34+
35+
That's all. It will be publish on [composer](https://packagist.org/packages/linecorp/line-bot-sdk) automatically.
36+
37+
e.g.
38+
39+
```
40+
$ git tag 1.2.3
41+
$ git push origin 1.2.3
42+
```
43+

README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -184,21 +184,7 @@ Requirements
184184
For SDK developers
185185
--
186186

187-
### How to run tests
188-
189-
Use `make test`.
190-
191-
### How to execute [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
192-
193-
Use `make phpcs`.
194-
195-
### How to execute [PHPMD](https://phpmd.org/)
196-
197-
Use `make phpmd`.
198-
199-
### How to execute them all
200-
201-
`make`
187+
Please refer [HACKING.md](/HACKING.md).
202188

203189
See also
204190
--

0 commit comments

Comments
 (0)