Merge pull request #699 from iqiyi/devel

v1.8.8

CONTRIBUTING.md

@@ -1,20 +1,91 @@
 # Contributing
 
-We are really glad you're reading this, because we need volunteer developers to enhance this open source project. Pls feel free to submit issues, bugfix or new features. We really appreciate any contributing work you made to the project.
+We are really glad that you are reading this, because we need volunteer developers and maintainers to enhance this open source project. Pls feel free to submit issues, bugfixes or new features. We really appreciate any contributing work you made to the project.
 
-How to contribute the project? In general, we follow the "fork-and-pull" [Git workflow](https://nvie.com/posts/a-successful-git-branching-model/). Two main branches with infinite lifetime exist: **master** and **devel**. It is recommended that you should follow the workflow if you want to submit a patch to the project.
+In general, you can contribute the project in three ways as listed below.
+
+* Contribute codes to the project, either bugfix or new feature is appreciated.
+* Review pull requests of the project.
+* Solve issues of the project.
+
+## 1. Contribute Codes
+
+How to contribute codes to the project? In general, we follow the "fork-and-pull" [Git workflow](https://nvie.com/posts/a-successful-git-branching-model/). Two main branches with infinite lifetime exist: **master** and **devel**. It is recommended that you should follow the workflow below if you want to submit a patch to the project.
 
 * S1. **Fork** the repo on Github.
-* S2. **Clone** the project to your own machine.
-* S3. **Checkout** to `devel` branch of the project on your own machine.
-* S4. **Commit** changes on your own branch.
-* S5. **Push** your work back up to your fork.
+* S2. **Clone** the project to your local develop environments.
+* S3. **Checkout** to `devel` branch of the project in you local develop environments.
+* S4. **Commit** changes on your local branch.
+* S5. **Push** your work back to the forked repo on Github.
 * S6. Submit a **Pull Request** so that we can review your changes.
 
 NOTE: Be sure to merge the latest from "upstream" before making a pull request!
 
+## 2. Review [Pull Requests](https://github.com/iqiyi/dpvs/pulls)
+
+In consideration of the complexity of some pull requests(PR), the DPVS PRs are reviewed in a stage by stage way. In order to demonstrate the PR review progress explictly, a series of [PR labels](https://github.com/iqiyi/dpvs/labels) are defined by DPVS Maintainers. All PR labels start with prefix 'pr/'. There are two types of PR labels: the stage labels, and the status labels. The former show what need to do of the current stage, while the later show the status of previous stages. According to whether problems were found in previous stages, status labels are of two types: status ok labels, and status false labels. The following table list all the PR labels that DPVS has defined.
+
+| stage                                                        | status /ok                                                   | status/false                                                 |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| <span style="background-color:#fbca04;">to-confirm-needs</span> | <span style="background-color:#e6f9a7;">needs-confirmed</span> | <span style="background-color:#ea3cc7;">do-not-need</span>   |
+| <span style="background-color:#fbca04;">to-confirm-bug</span> | <span style="background-color:#e6f9a7;">bug-confirmed</span> | <span style="background-color:#ea3cc7;">not-a-bug</span>     |
+| <span style="background-color:#fbca04;">to-review-codes</span> | <span style="background-color:#e6f9a7;">codes-reviewed-ok</span> | <span style="background-color:#ea3cc7;">codes-need-change</span> |
+| <span style="background-color:#fbca04;">to-test-codes</span> | <span style="background-color:#e6f9a7;">codes-tested-ok</span> | <span style="background-color:#ea3cc7;">codes-test-failed</span> |
+| <span style="background-color:#fbca04;">to-evaluate-performance</span> | <span style="background-color:#e6f9a7;">performance-ok</span> | <span style="background-color:#ea3cc7;">performance-bad</span> |
+| <span style="background-color:#fbca04;">to-test-compatibility</span> | <span style="background-color:#e6f9a7;">compatibility-ok</span> | <span style="background-color:#ea3cc7;">compatibility-bad</span> |
+| <span style="background-color:#fbca04;">to-accept-or-reject</span> | <span style="background-color:#e6f9a7;">accepted</span>      | <span style="background-color:#ea3cc7;">rejected</span>      |
+
+Different types of labels are colored with different colors. PR labels are described in summary here.
+* stage labels: colored <span style="background-color:#fbca04;">orange</span>, what to do for the PR.
+* status labels:
+  - status-ok labels: colored <span style="background-color:#e6f9a7;">green</span>, the PR status is ok and review progress can continue.
+  - status-false labels: colored <span style="background-color:#ea3cc7;">purple</span>, problems are found and the PR needs modification or to be rejected.
+
+The figure below shows the overall review progress of a PR.
+![maintainence-pr](./pic/maintainence-pr.png)
+
+* S1. DPVS maintainers assign a stage label(label of orange color) to a PR.
+* S2. Reviewers check the PR list, pick those labels with orange color, and do the current review stage work. Submit the review results within the PR.
+* S3. DPVS maintainers assign a status label according to the review results, i.e. a status-ok label if the no problem found of this stage, otherwise a status-false label.
+* S4. If subsequent review stages are needed, goto step S1, otherwise close the PR.
+
+It should be noted that not all the six stages are required for simple PRs. For example, "to-test-codes", "to-evaluate-performance" and "to-test-compatibility" stages may be skipped if they are not needed obviously.
+
+**Anyone can pick the PRs colored with orange and do the work of current stage. If your work is verified, it would take into account when we consider your activeness in DPVS community, and you may get awarded.**
+
+It is expected that the PRs should be reviewed in a week and closed(merged or rejected) in a month. Complicated PRs may need longer timer to review, maintainers should update the review progress timely and keep in touch with code contributors if the codes in the PR need modification before accepted.
+
+## 3. Solve [Issues](https://github.com/iqiyi/dpvs/issues)
+
+It's appreciated to help dpvs maintainers solve the Issues from DPVS community, especially those reporting bugs or problems. Nothing is more pleasant than helping others, isn't it?  Similar to PRs, a series of [issue labels](https://github.com/iqiyi/dpvs/labels) are defined by DPVS maintainers, which have fixed prefix 'issue/'. Similarly, the issue labels are also have different types.
+
+* stage labels: colored <span style="background-color:#fbca04;">orange</span>, what to do for the issue.
+* status labels:
+  - status-ok labels: colored <span style="background-color:#e6f9a7;">green</span>, the issue status is ok.
+  - status-false labels: colored <span style="background-color:#ea3cc7;">purple</span>, the issue is not a problem.
+
+| stage labels                                                | status/ok label                                           | status/false labels                                          |
+| ----------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------ |
+| <span style="background-color:#fbca04;">to-reproduce</span> | <span style="background-color:#e6f9a7;">reproduced</span> | <span style="background-color:#ea3cc7;">not-reproduced</span> |
+| <span style="background-color:#fbca04;">to-solve</span>     | <span style="background-color:#e6f9a7;">solved</span>     |                                                              |
+
+The figure below shows the processing progress of an DPVS issue.
+![maintainence-issue](./pic/maintainence-issues.png)
+
+**Anyone can pick the Issues colored orange and do the work of current stage. If the issue is confirmed to be solved, it would take into account when we consider your activeness in DPVS community, and you may get awarded.**
+
+It is expected that Issues should be replied in a week and solved in a month. If the issue author is not replied after a month from reply, the issue is closed.
+
 # Coding conventions
 
 Basically, codeing style should be consistent in the whole project. We recommend to use the [Linux kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#).
 
 NOTE: As for indentations, we use 4-char indents, not 8-char indents. This is different from Linux kernel coding style.
+
+# Rewards to Contributors
+
+The DPVS contributors(including code contributors, PR reviewers, and issue solvers) can be rewarded in the following aspects.
+
+* Excellent contributors should be invited into **DPVS maintainers**, who are granted with high privileges of the project.
+* IQIYI would prepare some **gold membership cards** for the active contributors every year.
+

LICENSE.md

@@ -1,6 +1,6 @@
 Main code of DPVS is [GNU General Public License, version 2 (GPLv2)](https://www.gnu.org/licenses/gpl-2.0.html) licensed.
 
-Copyright (C) 2017 [爱奇艺](http://www.iqiyi.com/). All Rights Reserved.
+Copyright (C) 2021 [爱奇艺](http://www.iqiyi.com/). All Rights Reserved.
 
 Other Dependencies:
 ===================

Makefile

@@ -1,7 +1,7 @@
 #
 # DPVS is a software load balancer (Virtual Server) based on DPDK.
 #
-# Copyright (C) 2017 iQIYI (www.iqiyi.com).
+# Copyright (C) 2021 iQIYI (www.iqiyi.com).
 # All Rights Reserved.
 #
 # This program is free software; you can redistribute it and/or