From 13ee045b99da746a81f236a523b2f9271a6649f1 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Tue, 1 Mar 2022 14:55:42 +0800 Subject: [PATCH] docs: add section 'How to Contribute' --- README.md | 13 ++++++++++++- README_zh-CN.md | 13 ++++++++++++- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4bd7379..b7a7b18 100644 --- a/README.md +++ b/README.md @@ -352,4 +352,15 @@ import "github.com/duke-git/lancet/validator" - [IsIpV6](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIpV6) - [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsStrongPassword) - [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsUrl) -- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword) \ No newline at end of file +- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword) + + +## How to Contribute + +I really appreciate any code commits which make lancet lib powerful. Please follow the rules below to create your pull request. + +1. Fork the repository. +2. Create your feature branch. +3. Commit your changes. +4. Push to the branch +5. Create new pull request. \ No newline at end of file diff --git a/README_zh-CN.md b/README_zh-CN.md index 6cee56c..426c0b2 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -356,4 +356,15 @@ import "github.com/duke-git/lancet/validator" - [IsIpV6](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsIpV6) - [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsStrongPassword) - [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsUrl) -- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsWeakPassword) \ No newline at end of file +- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsWeakPassword) + + +## 如何贡献代码 + +非常感激任何的代码提交以使lancet的功能越来越强大。创建pull request时请遵守以下规则。 + +1. Fork lancet仓库。 +2. 创建自己的特性分支。 +3. 提交变更。 +4. Push分支。 +5. 创建新的pull request。 \ No newline at end of file