Skip to content

Commit ff84f17

Browse files
committed
- Add contributing guide.
- Update README.
1 parent 88f72a3 commit ff84f17

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed

CONTRIBUTING.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing
2+
3+
- If you **need help**, [mail] me or ping me on [Twitter] or [Telegram].
4+
- If you **have suggestions that need to be discussed**, open an issue.
5+
- If you **found a bug**, open an issue.
6+
- If you **have a feature request**, open an issue.
7+
- If you **want to contribute**, submit a pull request.
8+
9+
### Pull Requests
10+
11+
We gladly accept any PR's assuming they are well written, documented ( if necessary ) and have test code.
12+
13+
If you're unsure if we'll accept a new feature please open an issue requesting it and we can have a discussion before you code and submit a PR.
14+
15+
If you update the regular expression, you must update its link.
16+
17+
If you change the list of test numbers for a regular expression, you must update the test numbers for all regular expressions to make sure they are consistent. This means you have to regenerate a new link for each regular expression and update it.
18+
19+
### Issues
20+
21+
Please use the issue tracker *strictly* for bugs you think are caused by a regular expression issue in ChinaMobilePhoneNumberRegex. We’re very busy and as a free open source library do not have the time to adequately help with questions that are more tutorial/training in nature and recommend using Stack Overflow and Google as alternatives.
22+
23+
Please do not be offended if we close your issue and reference this document. If you believe the issue is truly a fault in ChinaMobilePhoneNumberRegex’s regular expressions, re-open it.
24+
25+
26+
---
27+
28+
# 参与
29+
30+
- 如果你**需要帮助**,请给我发送[邮件][mail],也可以在 [Twitter][Telegram] 上联系我。
31+
- 如果你**有建议需要讨论**,请打开一个 issue。
32+
- 如果你**发现一个 bug**,请打开一个 issue。
33+
- 如果你**有一个功能请求**,请打开一个 issue。
34+
- 如果你**想要贡献代码**,请提交一个 PR。
35+
36+
### 合并请求
37+
38+
我们很乐意接受任何高质量、文档完整(如果需要)并且有完整测试的 PR。
39+
40+
如果您不确定我们是否接受新功能,请打开一个 issue 询问,我们可以在您编码和提交 PR 之前进行讨论。
41+
42+
如果您更新了正则表达式,您必须更新它的链接。
43+
44+
如果您改变了某一个正则表达式的测试号码列表,您必须更新所有正则表达式的测试号码,确保它们一致。这也就意味着您必须重新为每一个正则表达式生成一个新的链接并更新。
45+
46+
### Issues
47+
48+
*严格*使用 issue 来追踪您认为是由 ChinaMobilePhoneNumberRegex 中正则表达式的 bug 引起的问题。我们非常忙碌,作为一个免费的开源库,没有足够的时间来充分帮助解决更多教程 / 培训的问题,建议使用 Stack Overflow 和 Google 作为替代方案。
49+
50+
如果我们关闭您的问题,请不要生气。 如果您认为 ChinaMobilePhoneNumberRegex 的正则表达式确实有错误,请重新打开它。
51+
52+
53+
[mail]: mailto:vincentxueios@gmail.com
54+
[Twitter]: https://twitter.com/SuetFungSit
55+
[Telegram]: https://telegram.me/VincentXue
56+

README-CN.md

+8
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ https://www.debuggex.com (PCRE 在线视觉化)
134134

135135
[中国内地移动终端通讯号码 - 维基百科]
136136

137+
## 关注更新
138+
139+
由于手机号码正则表达式具有时效性,所以当任何正则表达式出现变更时,都会发布一个新版本来触发 GitHub 的邮件系统通知所有观察了本项目的用户。如果您希望在任何正则表达式出现变更时及时得到通知,请观察本项目。
140+
141+
[如何观察项目新版本?]
142+
137143
## 更新日志
138144

139145
#### 2019.01.10
@@ -218,3 +224,5 @@ MIT
218224

219225
[中国内地移动终端通讯号码 - 维基百科]: https://zh.wikipedia.org/wiki/%E4%B8%AD%E5%9B%BD%E5%86%85%E5%9C%B0%E7%A7%BB%E5%8A%A8%E7%BB%88%E7%AB%AF%E9%80%9A%E8%AE%AF%E5%8F%B7%E7%A0%81
220226

227+
[如何观察项目新版本?]: https://help.github.com/articles/watching-and-unwatching-releases-for-a-repository/#watching-releases-for-a-repository
228+

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,11 @@ https://www.debuggex.com (PCRE visualizer)
137137

138138
[Telephone numbers in China - Wikipedia]
139139

140+
## Stay up to date
141+
142+
Since the mobile phone number regular expression is time-sensitive, when any regular expression is updated, a new version will be released to trigger GitHub's mail system to notify all users who are watching the repository. If you want to be notified when any regular expressions are updated, please watch this repository.
143+
144+
[How to watch releases for a repository?]
140145

141146
## Release Notes
142147

@@ -225,3 +230,5 @@ MIT
225230
[Telephone numbers in China - Wikipedia]: https://en.wikipedia.org/wiki/Telephone_numbers_in_China
226231

227232

233+
[How to watch releases for a repository?]: https://help.github.com/articles/watching-and-unwatching-releases-for-a-repository/#watching-releases-for-a-repository
234+

0 commit comments

Comments
 (0)