github.com/cloudwego/frugal@v0.1.15/CONTRIBUTING.md (about)

     1  # How to Contribute
     2  
     3  ## Your First Pull Request
     4  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).
     5  
     6  ## Without Semantic Versioning
     7  We keep the stable code in branch `main` like `golang.org/x`. Development base on branch `develop`. And we promise the **Forward Compatibility** by adding new package directory with suffix `v2/v3` when code has break changes.
     8  
     9  ## Branch Organization
    10  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)
    11  
    12  ## Bugs
    13  ### 1. How to Find Known Issues
    14  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.
    15  
    16  ### 2. Reporting New Issues
    17  Providing a reduced test code is a recommended way for reporting issues. Then can placed in:
    18  - Just in issues
    19  - [Golang Playground](https://play.golang.org/)
    20  
    21  ### 3. Security Bugs
    22  Please do not report the safe disclosure of bugs to public issues. Contact us by [Support Email](mailto:conduct@cloudwego.io)
    23  
    24  ## How to Get in Touch
    25  - [Email](mailto:conduct@cloudwego.io)
    26  
    27  ## Submit a Pull Request
    28  Before you submit your Pull Request (PR) consider the following guidelines:
    29  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.
    30  2. Please submit an issue instead of PR if you have a better suggestion for format tools. We won't accept a lot of file changes directly without issue statement and assignment.
    31  3. Be sure that the issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Before we accepting your work, we need to conduct some checks and evaluations. So, It will be better if you can discuss the design with us.
    32  4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego/kitex repo.
    33  5. In your forked repository, make your changes in a new git branch:
    34      ```
    35      git checkout -b my-fix-branch develop
    36      ```
    37  6. Create your patch, including appropriate test cases.
    38  7. Follow our [Style Guides](#code-style-guides).
    39  8. Commit your changes using a descriptive commit message that follows [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).
    40     Adherence to these conventions is necessary because release notes are automatically generated from these messages.
    41  9. Push your branch to GitHub:
    42      ```
    43      git push origin my-fix-branch
    44      ```
    45  10. In GitHub, send a pull request to `kitex:develop` with a clear and unambiguous title.
    46  
    47  ## Contribution Prerequisites
    48  - Our development environment keeps up with [Go Official](https://golang.org/project/).
    49  - 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)
    50  - You are familiar with [Github](https://github.com)
    51  - Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool).
    52  
    53  ## Code Style Guides
    54  
    55  See [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments).
    56  
    57  Good resources:
    58  - [Effective Go](https://golang.org/doc/effective_go)
    59  - [Pingcap General advice](https://pingcap.github.io/style-guide/general.html)
    60  - [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md)