You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by li...@apache.org on 2015/03/28 01:05:10 UTC
[19/19] incubator-kylin git commit: refine how to contribute doc
refine how to contribute doc
Project: http://git-wip-us.apache.org/repos/asf/incubator-kylin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-kylin/commit/23f0dae9
Tree: http://git-wip-us.apache.org/repos/asf/incubator-kylin/tree/23f0dae9
Diff: http://git-wip-us.apache.org/repos/asf/incubator-kylin/diff/23f0dae9
Branch: refs/heads/staging
Commit: 23f0dae956750b46b9b4de07aa1bc4164293b057
Parents: b876b7a
Author: Yang Li <li...@apache.org>
Authored: Sat Mar 28 01:02:51 2015 +0100
Committer: Yang Li <li...@apache.org>
Committed: Sat Mar 28 01:02:51 2015 +0100
----------------------------------------------------------------------
docs/MISC/How to Contribute.md | 43 ++++++++++++++++---------------------
1 file changed, 19 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/23f0dae9/docs/MISC/How to Contribute.md
----------------------------------------------------------------------
diff --git a/docs/MISC/How to Contribute.md b/docs/MISC/How to Contribute.md
index e270606..90c9732 100644
--- a/docs/MISC/How to Contribute.md
+++ b/docs/MISC/How to Contribute.md
@@ -1,41 +1,36 @@
#### Setup Dev Env
-* subscribe our developers' mail list via <de...@kylin.incubator.apache.org>
-* Fork on [GitHub](https://github.com/KylinOLAP)
+* Subscribe our developers' mail list via <de...@kylin.incubator.apache.org>
+* Fork from [GitHub](https://github.com/apache/incubator-kylin) *staging* branch, it is the bug fix branch of master.
* ...
#### Making Changes
-* Raise an issue on GitHub, describe the feature/enhancement/bug
-* Discuss with others in google group or issue comments, make sure the proposed changes fit in with what others are doing and have planned for the project
-* Make changes in your fork
-* Write unit test if no existing cover your change
-* Push to GitHub under your fork
+* Discuss feature/enhancement/bug you plan to do in dev mail list, get consensus before you start.
+* Create a [JIRA](https://issues.apache.org/jira/browse/KYLIN) to describe your task
+* Make changes in your fork.
+* Write unit test to cover your change.
#### Contribute The Work
-* Raise a pull request on GitHub, include both **code** and **test**, link with **related issue**
-* Committer will review in terms of correctness, performance, design, coding style, test coverage
-* Discuss and revise if necessary
-* Finally committer merge code into main branch
+* Pull request to *staging* branch.
+* Committer review in terms of correctness, performance, design, coding style, test coverage.
+* Discuss and revise if necessary.
+* Committer merge code into *staging*.
+* After integration test, change merges into master.
#### Wish List
-Some potential work items
+Some work items for new joiners.
* Query Engine
- * Cache generated class, reduce delay into ms level and avoid full GC triggered by perm generation
- * [Issue #14](https://github.com/KylinOLAP/Kylin/issues/14) Derive meaningful cost in OLAP relational operator
- * [Issue #15](https://github.com/KylinOLAP/Kylin/issues/15) Implement multi-column distinct count
-* Metadata
- * [Issue #7](https://github.com/KylinOLAP/Kylin/issues/7) Merge multiple hbase tables
+ * Cache Calcite generated class, reduce delay into ms level and avoid full GC triggered by perm generation
+ * [KYLIN-491](https://issues.apache.org/jira/browse/KYLIN-491) Derive meaningful cost in OLAP relational operator
* Job Engine
- * [Issue #16](https://github.com/KylinOLAP/Kylin/issues/16) Tune HDFS & HBase parameters
- * [Issue #17](https://github.com/KylinOLAP/Kylin/issues/17) Increase HDFS block size 1GB or close
- * Shell command to support kill operation
- * Use DoubleDouble instead of BigDecimal during cube build
- * Drop quartz dependency, assess the cost/benefit first
- * Cardinality run as one step job, allows progress tracking
+ * [KYLIN-489](https://issues.apache.org/jira/browse/KYLIN-489) Tune HDFS & HBase parameters. Requires a hadoop cluster of 10+ nodes.
+ * Fork some build step (build dictionary, create hbase table) as child process, better resource cleanup and easier troubleshooting.
+ * Use DoubleDouble instead of BigDecimal during cube build. Expect better CPU performance.
* ODBC/JDBC
* Test Kylin remote JDBC with java report tools
- * Implement ODBC async mode, fetching from Kylin and feeding to client in parallel
+ * [KYLIN-602](https://issues.apache.org/jira/browse/KYLIN-602) ODBC driver support excel
+ * Implement ODBC async mode, streaming from Kylin and feeding to client
* Benchmark
* [Issue #18](https://github.com/KylinOLAP/Kylin/issues/18) Benchmark on standard dataset