Skip to content

Commit 2c14ba1

Browse files
authored
Merge pull request #453 from PyThaiNLP/dev
Update CONTRIBUTING.md
2 parents 38b7520 + 789dc57 commit 2c14ba1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ automatically from "docstring" comments in source code. This means the comment
5555
section in the source code is important for the quality of documentation.
5656
- A docstring should start with one summary line, ended the line with a full stop (period),
5757
then followed by a blank line before the start new paragraph.
58+
- A commit to release branches (e.g. `2.2`, `2.1`) with a title **"(build and deploy docs)"** (without quotes) will trigger the system to rebuild the documentation files and upload them to the website https://pythainlp.github.io/docs.html
5859

5960

6061
## Testing
@@ -95,6 +96,9 @@ Make sure the same tests pass on Travis CI and AppVeyor.
9596
bumpversion build
9697
#current_version = 2.2.2-dev2
9798
99+
bumpversion release
100+
#current_version = 2.2.2-beta0
101+
98102
bumpversion release
99103
#current_version = 2.2.2
100104
@@ -110,11 +114,13 @@ Make sure the same tests pass on Travis CI and AppVeyor.
110114
bumpversion major
111115
#current_version = 3.0.0-dev0
112116
117+
bumpversion release
118+
#current_version = 3.0.0-beta0
119+
113120
bumpversion release
114121
#current_version = 3.0.0
115122
```
116123

117-
118124
## Credits
119125

120126
<a href="https://github.com/PyThaiNLP/pythainlp/graphs/contributors">

0 commit comments

Comments
 (0)