From d9b36043d50897ee9e91ed22288652376c786af2 Mon Sep 17 00:00:00 2001 From: Guangming Luo Date: Thu, 11 Jul 2024 11:34:54 +0800 Subject: [PATCH 1/2] chore: update gitignore & CONTRIBUTING --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .gitignore | 7 +++++++ CONTRIBUTING.md | 4 ---- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9b7368d..28bb067 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -27,9 +27,9 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. -**Kitex version:** +**Version:** -Please provide the version of Kitex you are using. +Please provide the version of {project_name} you are using. **Environment:** diff --git a/.gitignore b/.gitignore index 644df37..398f12b 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,13 @@ # Dependency directories (remove the comment below to include it) # vendor/ +# Go workspace file +go.work +go.work.sum + +# env file +.env + # the result of the go build output* output/* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e60a59e..bcb27a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,9 +47,5 @@ Before you submit your Pull Request (PR) consider the following guidelines: - Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool). ## Code Style Guides -Also see [Pingcap General advice](https://pingcap.github.io/style-guide/general.html). - -Good resources: - [Effective Go](https://golang.org/doc/effective_go) - [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) -- [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) From 532acedd6f3434cd64b54fba33193ae67c431732 Mon Sep 17 00:00:00 2001 From: Guangming Luo Date: Thu, 11 Jul 2024 12:02:19 +0800 Subject: [PATCH 2/2] fix hard code --- .golangci.yaml | 1 - CONTRIBUTING.md | 14 +++++++------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.golangci.yaml b/.golangci.yaml index 71405b0..ec7a899 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -3,7 +3,6 @@ run: # include `vendor` `third_party` `testdata` `examples` `Godeps` `builtin` skip-dirs-use-default: true skip-dirs: - - kitex_gen skip-files: - ".*\\.mock\\.go$" # output configuration options diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcb27a3..db3d580 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,17 @@ # How to Contribute ## Your First Pull Request -We use github for our codebase. You can start by reading [How To Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). +We use GitHub for our codebase. You can start by reading [How To Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). ## Branch Organization We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) as our branch organization, as known as [FDD](https://en.wikipedia.org/wiki/Feature-driven_development) ## Bugs ### 1. How to Find Known Issues -We are using [Github Issues](https://github.com/cloudwego/kitex/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist. +We are using [Github Issues](https://github.com/cloudwego/{project_name}/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist. ### 2. Reporting New Issues -Providing a reduced test code is a recommended way for reporting issues. Then can placed in: +Providing a reduced test code is a recommended way for reporting issues. Then can place in: - Just in issues - [Golang Playground](https://play.golang.org/) @@ -23,9 +23,9 @@ Please do not report the safe disclosure of bugs to public issues. Contact us by ## Submit a Pull Request Before you submit your Pull Request (PR) consider the following guidelines: -1. Search [GitHub](https://github.com/cloudwego/kitex/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. +1. Search [GitHub](https://github.com/cloudwego/{project_name}/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. 2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work. -3. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego/kitex repo. +3. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego {project_name} repo. 4. In your forked repository, make your changes in a new git branch: ``` git checkout -b my-fix-branch develop @@ -38,12 +38,12 @@ Before you submit your Pull Request (PR) consider the following guidelines: ``` git push origin my-fix-branch ``` -9. In GitHub, send a pull request to `kitex:develop` +9. In GitHub, send a pull request to `{project_name}:develop` ## Contribution Prerequisites - Our development environment keeps up with [Go Official](https://golang.org/project/). - You need fully checking with lint tools before submit your pull request. [gofmt](https://golang.org/pkg/cmd/gofmt/) and [golangci-lint](https://github.com/golangci/golangci-lint) -- You are familiar with [Github](https://github.com) +- You are familiar with [GitHub](https://github.com) - Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool). ## Code Style Guides