Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

57 lines (46 loc) · 3.74 KB
Raw

How to Contribute

Your First Pull Request

We use github for our codebase. You can start by reading How To Pull Request.

Branch Organization

We use git-flow as our branch organization, as known as FDD

Bugs

1. How to Find Known Issues

We are using Github 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:

3. Security Bugs

Please do not report the safe disclosure of bugs to public issues. Contact us by Support Email

How to Get in Touch

Submit a Pull Request

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
  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.
  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.
  4. Fork the cloudwego/kitex repo.
  5. In your forked repository, make your changes in a new git branch: 
    git checkout -b my-fix-branch develop
  6. Create your patch, including appropriate test cases. Please refer to Go-UT for writing guides. Go-Mock is recommended to mock interface, please refer to internal/mocks/readme.md for more details, and Mockey is recommended to mock functions, please refer to its readme doc for specific usage.
  7. Follow our Style Guides.
  8. Commit your changes using a descriptive commit message that follows AngularJS Git Commit Message Conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
  9. Push your branch to GitHub: 
    git push origin my-fix-branch
  10. In GitHub, send a pull request to kitex:develop with a clear and unambiguous title.

Contribution Prerequisites

  • Our development environment keeps up with Go Official.
  • You need fully checking with lint tools before submit your pull request. gofmt and golangci-lint
  • You are familiar with Github
  • Maybe you need familiar with Actions(our default workflow tool).

Code Style Guides

See Go Code Review Comments.

Good resources: