1# How to Contribute
2
3## Your First Pull Request
4We 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).
5
6## Branch Organization
7We 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)
8
9## Bugs
10### 1. How to Find Known Issues
11We 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.
12
13### 2. Reporting New Issues
14Providing a reduced test code is a recommended way for reporting issues. Then can placed in:
15- Just in issues
16- [Golang Playground](https://play.golang.org/)
17
18### 3. Security Bugs
19Please do not report the safe disclosure of bugs to public issues. Contact us by [Support Email](mailto:conduct@cloudwego.io)
20
21## How to Get in Touch
22- [Email](mailto:conduct@cloudwego.io)
23
24## Submit a Pull Request
25Before you submit your Pull Request (PR) consider the following guidelines:
261. 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.
272. 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.
283. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego/kitex repo.
294. In your forked repository, make your changes in a new git branch:
30 ```
31 git checkout -b my-fix-branch develop
32 ```
335. Create your patch, including appropriate test cases.
346. Follow our [Style Guides](#code-style-guides).
357. Commit your changes using a descriptive commit message that follows [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).
36 Adherence to these conventions is necessary because release notes are automatically generated from these messages.
378. Push your branch to GitHub:
38 ```
39 git push origin my-fix-branch
40 ```
419. In GitHub, send a pull request to `kitex:develop`
42
43## Contribution Prerequisites
44- Our development environment keeps up with [Go Official](https://golang.org/project/).
45- 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)
46- You are familiar with [Github](https://github.com)
47- Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool).
48
49## Code Style Guides
50Also see [Pingcap General advice](https://pingcap.github.io/style-guide/general.html).
51
52Good resources:
53- [Effective Go](https://golang.org/doc/effective_go)
54- [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
55- [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md)
View as plain text