Skip to main content

Join Us

Summary​

go-zero

go-zero is an open source project based on MIT License, everyone In the use of the discovery of bugs, new features, etc., can participate in the go-zero contribution, we very welcome your active participation, but also the fastest response to all kinds of questions, pr, etc.

Contribution​

contributions

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

  • English comments should be the main focus
  • pr with good functional features and clear, concise descriptions
  • Increase unit test coverage to 80%+.

Contribute code (pr)​

  • Go to the go-zero project and fork a copy of the go-zero project to your own github repository.
  • Go back to your own github home page and find the xx/go-zero project, where xx is your username, e.g. anqiansong/go-zero

fork

  • Cloning code to local

clone

  • Develop the code and push it to your own github repository
  • Go to your own go-zero project in github, click [Pull requests] on the floating layer to enter the Compare page.

pr

  • Click [Create pull request] to realize pr request
  • To check if the pr is submitted successfully, go to Pull requests of go-zero and you should have your own submission The name of the branch is the name of your development

pr record

Issue​

In our community, there are many partners will actively feedback some go-zero use process problems encountered, due to the number of community, although we will pay attention to the community dynamics in real time, but everyone's problem feedback is random, when our team is still solving a partner's problem, another problem also feedback up, may lead to the team will be easy to ignore, in order to be able to In order to solve everyone's problems one by one, we strongly recommend that you give feedback through the issue, including but not limited to bugs, expected new features, etc. We will also reflect in the issue when implementing a new feature, you can also get the latest trends of go-zero here, and welcome you to actively participate in the discussion.

How to mention Issue​

  • Click here to go to go-zero's Issue page or go directly to https://github.com/zeromicro/go-zero/issues github.com/zeromicro/go-zero/issues) address
  • Click [New issue] in the upper right corner to create a new issue
  • Fill in the issue title and content
  • Click [Submit new issue] to submit the issue

Document Contribution​

The documentation repository go-zero.dev, built with docusaurus, will automatically trigger Github Actions when the documentation changes are merged into the master branch for automatic deployment.

Adding/modifying documentation​

First fork the docs repository and clone your own repository to local, then add and modify docs in the corresponding subdirectory in the docs directory, the doc format is Markdown and supports some extended syntax, please refer to Docusaurus: Markdown Features for the supported syntax docusaurus.io/docs/markdown-features)

Submit pr​

After adding/modifying a document, you can submit the pr and wait for the team to merge the document.

Reference documentation​