Contributing

Summary#

go-zero

go-zero is an open-source project based on the MIT License. If you find bugs, have questions, or want to introduce new features, your contributions to the project are encouraged! We welcome your active participation and will respond to various questions, issues, and PRs as soon as possible.

Contribution form#

Contribution notes#

The code in go-zero's Pull request needs to meet certain specifications:

  • For naming conventions, please read the naming conventions doc.
  • Code annotations should be in English where possible
  • Pull Requests should describe the functional needs clearly and concisely
  • Unit test coverage should be 80% at a minimum

Pull Requests(PRs)#

  • Visit the go-zero project, and fork it to a new GitHub repository under your account

  • Go back to your GitHub homepage and find the xx/go-zero project, where xx is your username. (e.g. anqiansong/go-zero)

    fork

  • Clone the code to your local machine

    clone

  • Develop your changes locally and then push them back to your GitHub repository

  • From your account's go-zero project, click on Pull request in the branch info box

    pr

  • For the base repository, choose zeromicro/go-zero with base:master. For the head repository choose your go-zero project (e.g. xx/go-zero) and compare:$branch with $branch being the new feature branch in your repository that you want merged back into the upstream project

    pr

  • Click [Create pull request]

  • To confirm whether the PR submitted successfully, enter the go-zero Pull requests page and look for your submission with your branch name

    pr record

Issues#

Our community will make every effort to actively provide feedback and support for problems encountered while using go-zero. However, due to the large number of people in the community both asking and answering questions, we make no guarantees about the order in which questions will be answered. Additionally, while our team is working on issues raised by the community, time constraints could cause some questions to go unanswered. One way to mitigate this is to post all feedback, be it regarding new features or discovered bugs, as a github issue for easier tracking. The go-zero team will also ensure that new features have their own issue created for easy reference by the community. The issues page is also where you can keep track of the latest go-zero news. We welcome everyone to actively participate in the issues page and community discussions.

How to create a new issue#

  • Navigate to the go-zero issues page
  • Click [New issue] in the upper right corner
  • Choose the issue category from [Bug report], [Feature request], or [Question]
  • Fill in the issue title and content
  • Click [Submit new issue]

Reference#

Last updated on