代码拉取完成，页面将自动刷新
It is warmly welcomed if you have interest to hack on Dragonfly. First, we encourage this kind of willing very much. And here is a list of contributing guide for you.
Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Dragonfly, please do not discuss it in public and even do not open a public issue. Instead we encourage you to send us a private email to dragonfly-dev@service.alibaba.com to report this.
To be honest, we regard every user of Dragonfly as a very kind contributor. After experiencing Dragonfly, you may have some feedback for the project. Then feel free to open an issue via NEW ISSUE.
Since we collaborate project Dragonfly in a distributed way, we appreciate WELL-WRITTEN, DETAILED, EXPLICIT issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
To make the issue details as standard as possible, we setup an ISSUE TEMPLATE for issue reporters. You can find three kinds of issue templates there: question, bug report and feature request. Please BE SURE to follow the instructions to fill fields in template.
There are lot of cases when you could open an issue:
Also we must remind that when filing a new issue, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.
Every action to make project Dragonfly better is encouraged. On GitHub, every improvement for Dragonfly could be via a PR (short for pull request).
Actually it is impossible to list them completely. Just remember one princinple:
WE ARE LOOKING FORWARD TO ANY PR FROM YOU.
Since you are ready to improve Dragonfly with a PR, we suggest you could take a look at the PR rules here.
To put forward a PR, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:
FORK Dragonfly to your repository. To make this work, you just need to click the button Fork in right-left of dragonflyoss/Dragonfly main page. Then you will end up with your repository in https://github.com/<your-username>/Dragonfly, in which your-username is your GitHub username.
CLONE your own repository to develop locally. Use git clone https://github.com/<your-username>/Dragonfly.git to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
Set Remote upstream to be https://github.com/dragonflyoss/Dragonfly.git using the following two commands:
git remote add upstream https://github.com/dragonflyoss/Dragonfly.git
git remote set-url --push upstream no-pushing
With this remote setting, you can check your git remote configuration like this:
$ git remote -v
origin https://github.com/<your-username>/Dragonfly.git (fetch)
origin https://github.com/<your-username>/Dragonfly.git (push)
upstream https://github.com/dragonflyoss/Dragonfly.git (fetch)
upstream no-pushing (push)
Adding this, we can easily synchronize local branches with upstream branches.
Create a branch to add a new feature or fix issues
Update local working directory:
cd Dragonfly
git fetch upstream
git checkout master
git rebase upstream/master
Create a new branch:
git checkout -b <new-branch>
Make any change on the new-branch then build and test your codes.
Right now we assume every contribution via pull request is for branch master in Dragonfly. Before contributing, be aware of branch definition would help a lot.
As a contributor, keep in mind again that every contribution via pull request is for branch master. While in project Dragonfly, there are several other branches, we generally call them rc branches, release branches and backport branches.
Before officially releasing a version, we will checkout a rc(release candidate) branch. In this branch, we will test more than branch master.
When officially releasing a version, there will be a release branch before tagging. After tagging, we will delete the release branch.
When backporting some fixes to existing released version, we will checkout backport branches. After backporting, the backporting effects will be in PATCH number in MAJOR.MINOR.PATCH of SemVer.
Actually in Dragonfly, we take two rules serious when committing:
Commit message could help reviewers better understand what the purpose of submitted PR is. It could help accelerate the code review procedure as well. We encourage contributors to use EXPLICIT commit message rather than ambiguous message. In general, we advocate the following commit message type:
On the other side, we discourage contributors from committing message like the following ways:
Commit content represents all content changes included in one commit. We had better include things in one single commit which could support reviewer's complete review without any other commits' help. In another word, contents in one single commit can pass the CI to avoid code mess. In brief, there are two minor rules for us to keep in mind:
No matter what the commit message, or commit content is, we do take more emphasis on code review.
PR is the only way to make change to Dragonfly project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the PR template to finish the pull request.
As a contributor, if you want to make any contribution to Dragonfly project, we should reach an agreement on the version of tools used in the development environment. Here are some dependents with specific version:
When you develop the Dragonfly project at the local environment, you should use subcommands of Makefile to help yourself to check and build the latest version of Dragonfly. For the convenience of developers, we use the docker to build Dragonfly. It can reduce problems of the developing environment.
The Dragonfly project uses Go modules to manage dependencies on external packages. This requires a working Go environment with version 1.12 or greater installed.
To add or update a new dependency, use the go get command:
# Pick the latest tagged release.
go get example.com/some/module/pkg
# Pick a specific version.
go get example.com/some/module/pkg@vX.Y.Z
Tidy up the go.mod and go.sum files:
make go-mod-tidy
You have to commit the changes to go.mod, go.sum before submitting the pull request.
git add go.mod go.sum
git commit
We choose GitHub as the primary place for Dragonfly to collaborate. So the latest updates of Dragonfly are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
In a word, ANY HELP IS CONTRIBUTION.
It is also welcomed to join Dragonfly team if you are willing to participate in Dragonfly community continuously and keep active.
You can do it in either of two ways:
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。