From 33b4cffe60d886465c759eefc90f04020823e23f Mon Sep 17 00:00:00 2001 From: dudaodong Date: Sun, 17 Mar 2024 10:30:07 +0800 Subject: [PATCH] rename CONTRIBUTING file --- CONTRIBUTING.en-US.md | 37 ------------------------------------- README.md | 2 +- 2 files changed, 1 insertion(+), 38 deletions(-) delete mode 100644 CONTRIBUTING.en-US.md diff --git a/CONTRIBUTING.en-US.md b/CONTRIBUTING.en-US.md deleted file mode 100644 index 4ef90ba3..00000000 --- a/CONTRIBUTING.en-US.md +++ /dev/null @@ -1,37 +0,0 @@ -# Lancet Contributing Guide - -Hi! Thank you for choosing Lancet. - -Lancet is a powerful, efficient, and reusable util function library of go. It makes Go dev easier by taking the hassle out of working with concurrency, net, math, slice, string, etc. - -We are excited that you are interested in contributing to lancet. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines. - -## Issue Guidelines - -- Issues are exclusively for bug reports, feature requests and design-related topics. Other questions may be closed directly. - -- Before submitting an issue, please check if similar problems have already been issued. - -- Please specify which version of Lancet and Go you are using, and provide OS information. [Go Playground](https://go.dev/play/) is recommended to build a live demo so that your issue can be reproduced clearly. - -## Pull Request Guidelines - -- Fork this repository to your own account. Do not create branches here. - -- Commit info should be formatted as `type(scope): info about commit`. eg. `fix(package): [scrollbar] fix xxx bug`. - - 1. type: type must be one of [chore, docs, feat, fix, refactor, release, test]. - - 2. scope: scope must be one of [package, file, internal]. - - 3. header: header must not be longer than 72 characters. - -- Rebase before creating a PR to keep commit history clear. - -- Before submitting a PR, please execute the unit test command: `go test -v ./...` to ensure that all unit test tasks should pass. - -- Make sure PRs are created to `rc` branch instead of other branch. - -- If your PR fixes a bug, please provide a description about the related bug. - -- If the PR is for a new feature, make sure to complete the relevant documentation (/lancet/docs/en/api/packages). diff --git a/README.md b/README.md index 41f1d744..3a7aa0de 100644 --- a/README.md +++ b/README.md @@ -2024,7 +2024,7 @@ import "github.com/duke-git/lancet/v2/xerror" ## How to Contribute -#### [Contributing Guide](./CONTRIBUTING.en-US.md) +#### [Contributing Guide](./CONTRIBUTING.md) ## Contributors Thank you to all the people who contributed to lancet!