Repository: kylin Updated Branches: refs/heads/document 0d2970889 -> fc11ef1ef
refine how to contribute docs Project: http://git-wip-us.apache.org/repos/asf/kylin/repo Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/fc11ef1e Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/fc11ef1e Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/fc11ef1e Branch: refs/heads/document Commit: fc11ef1ef25a8f2e736b6b3a2f180a8f331ad0a9 Parents: 0d29708 Author: Li Yang <liy...@apache.org> Authored: Sat Jul 29 17:08:33 2017 +0800 Committer: Li Yang <liy...@apache.org> Committed: Sat Jul 29 17:08:33 2017 +0800 ---------------------------------------------------------------------- website/_dev/howto_contribute.md | 28 ++++++++++++++++++++++++---- website/_dev/index.md | 12 +++++++----- 2 files changed, 31 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kylin/blob/fc11ef1e/website/_dev/howto_contribute.md ---------------------------------------------------------------------- diff --git a/website/_dev/howto_contribute.md b/website/_dev/howto_contribute.md index b865dd3..bccb2d5 100644 --- a/website/_dev/howto_contribute.md +++ b/website/_dev/howto_contribute.md @@ -5,12 +5,21 @@ categories: development permalink: /development/howto_contribute.html --- -## Current branches +Apache Kylin is always looking for contributions of not only code, but also usage document, performance report, Q&A etc. All kinds of contributions pave the way towards a Kylin Committer. There is opportunity for everyone, especially for those come from analysis and solution background, due to the lacking of content from user and solution perspective. + +## Source Branches + +Both code and document are under Git source control. Note the purpose of different branches. + * `master`: Main development branch for new features -* `1.3.x`: Maintenance branch for a certain release +* `2.0.x`: Maintenance branch for a certain release * `document`: Document branch -## Making Changes +## Making Document Changes + +Check out [How to Write Document](/development/howto_docs.html). + +## Making Code Changes * [Setup dev env](/development/dev_env.html) * Raise a JIRA, describe the feature/enhancement/bug * Discuss with others in mailing list or issue comments, make sure the proposed changes fit in with what others are doing and have planned for the project @@ -22,7 +31,18 @@ permalink: /development/howto_contribute.html ## Apply Patch -* Committer will review in terms of correctness, performance, design, coding style, test coverage +* Committer will review all patches in terms of correctness, performance, design, coding style, test coverage * Discuss and revise if necessary * Finally committer merge code into target branch * We use `git rebase` to ensure the merged result is a streamline of commits. + +## Pick an Open Task + +There are open tasks waiting to be done, tracked by JIRA. To make it easier to search, there are a few JIRA filters. + +* [A list of tasks](https://issues.apache.org/jira/issues/?filter=12339895) managed by Yang Li. +* [A list of tasks](https://issues.apache.org/jira/issues/?filter=12341496) opened by Ted Yu, important small bugs and some are easy fixes. +* Also you can search for tag "newbie" in Kylin JIRA. + +Do not forget to discuss in [mailing list](/community/index.html) before working on a big task. + http://git-wip-us.apache.org/repos/asf/kylin/blob/fc11ef1e/website/_dev/index.md ---------------------------------------------------------------------- diff --git a/website/_dev/index.md b/website/_dev/index.md index 7e8ec29..e83f987 100644 --- a/website/_dev/index.md +++ b/website/_dev/index.md @@ -4,7 +4,12 @@ title: Development Quick Guide permalink: /development/index.html --- -### Source Code +Apache Kylin is always looking for contributions of not only code, but also usage document, performance report, Q&A etc. All kinds of contributions pave the way towards a Kylin Committer. There is opportunity for everyone, especially for those come from analysis and solution background, due to the lacking of content from user and solution perspective. + +### How to Contribute +Check out the [How to Contribute](/development/howto_contribute.html) document. + +### Source Repository Apache Kylin⢠source code is version controlled using Git version control: Commits [Summary](https://git-wip-us.apache.org/repos/asf?p=kylin.git;a=summary) Source Repo: [git://git.apache.org/kylin.git](git://git.apache.org/kylin.git) @@ -18,13 +23,10 @@ Static Code Analysis: [SonarCube dashboard](https://builds.apache.org/analysis/o ### Issue Tracking Track issues on the "Kylin" Project on the Apache JIRA ([browse](http://issues.apache.org/jira/browse/KYLIN)). -### Setup Development Env -Refer to this link for how to setup dev env: [Setup Development Env](/development/dev_env.html) - ### Roadmap - Hadoop 3.0 support (Erasure Coding) - Spark cubing enhancement - Connect more sources (JDBC, SparkSQL) - Ad-hoc queries without cubing - Better storage (Kudu?) -- Real-time analytics with Lambda Architecture \ No newline at end of file +- Real-time analytics with Lambda Architecture
