Skip to content

Commit

Permalink
add issue and pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
Lingtaonju committed Aug 29, 2018
1 parent 2f2422b commit c24a15b
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 10 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/Add_New_Feature.md
@@ -0,0 +1,14 @@
### The New Feature

describe the new feature you want to support clearly

### Your scenes

describe your use scenes (why need this feature)

### Your advice

describe the advice or solution of this new feature

### Environment
+ SOFAMosn Version
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/Ask_Question.md
@@ -0,0 +1,6 @@
### Your question

describe your question clearly

### Environment
+ SOFAMosn Version
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_Report.md
@@ -0,0 +1,14 @@
### Describe the bug

A clear and concise description of what the bug is.

### Expected behavior

### Actual behavior

### Steps to reproduce

### Minimal yet complete reproducer code (or GitHub URL to code)

### Environment
+ SOFAMosn Version
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,21 @@
### Issues associated with this PR

Your PR should present related issues you want to solve.

### Sign the CLA
Make sure you has singed the [CLA](https://www.clahub.com/agreements/alipay/sofa-mosn)

### Solutions
You should show your solutions about the issues in your PR, including the overall solutions,
details and the changes. At this time, Chinese is allowed to describe these.

### UT result
Unit Test is need if code is changed, your unit test should cover boundary cases, corner cases and some exception cases.
And you need to show the ut result.

### Benchmark
If your code involve the processing of every request, you should give the Benchmark Result

### Code Style
+ Make sure `Goimports` has run
+ Show `Golint` result
16 changes: 8 additions & 8 deletions docs/CONTRIBUTING.md
Expand Up @@ -39,13 +39,13 @@ of the commit message (where XXXX is the issue number).

8. Please ensure that code coverage will not decrease.

9. Contribute a PR as the rule of Gitflow Workflow, and you should follow pull request's rules as bellow.
9. Contribute a PR as the rule of Gitflow Workflow, and you should follow pull request's rules.
As you may know, MOSN's version contains three digit, the first one is for compatibility; the second one is for new features and enhancement; the last one is for bug fix.

### Pull Request and Review Rules
1. Your PR should present related issues you want to solve and we will check that.
2. You should show your solutions about the issues in your PR, including the overall solutions, details and the changes. At this time,  Chinese is allowed to describe these.
3. Unit test description is needed, and we will check your ut, including boundary cases, corner cases and some exception cases.
4. Benchmark description is needed if your code involve the processing of every request, and we wil run the benchmark and make a comparision.
5. We will discuss and pay attention to the code which make the code structure change, the usage of the global variable, the handling of the corner case and concurrency
6. We will run golints to make your code style legal.
### PR review policy for maintainers
1. Check the issue with this PR
2. Check the solution's reasonability
3. Check UT's and Benchmark's result
4. Pay attention to the code which make the code structure change,
the usage of the global variable, the handling of the corner case and concurrency
5. Check 'goimports' and 'golint' result+ HSF(ongoing)
1 change: 0 additions & 1 deletion docs/README.md
Expand Up @@ -22,7 +22,6 @@ follow-up development and build an open source boutique project together.
+ HTTP/1.1,HTTP/2.0
+ SOFARPC
+ Dubbo(ongoing)
+ HSF(ongoing)
+ Routing support
+ Routing in form of virtual host
+ Routing with headers/url/prefix
Expand Down
1 change: 0 additions & 1 deletion docs/README_CN.md
Expand Up @@ -18,7 +18,6 @@ MOSN是一款采用 Golang 开发的Service Mesh数据平面代理,功能和
+ 支持HTTP/1.1,HTTP/2
+ 支持SOFARPC
+ 支持Dubbo协议(开发中)
+ 支持HSF协议(开发中)
+ 核心路由
+ 支持virtual host路由
+ 支持headers/url/prefix路由
Expand Down

0 comments on commit c24a15b

Please sign in to comment.