Nice proposal, +1.

To enforce property naming convention, I suggest making a clear list of all 
allowed packages. New package should be avoided as much as possible.

Cheers,
Dayue

> 在 2016年11月18日,下午4:18,Li Yang <[email protected]> 写道:
> 
> Hi
> 
> The kylin config files and properties lack of a naming convention at the
> moment. The result is messy. I want to establish a convention, start by
> throwing out a proposal and getting your feedback.
> 
> There is no right or wrong convention. People's preference varies and that
> is fine. However to work as a team, consistency is required. So let's
> compromise where possible.
> 
> *File Name Convention*
> 
> Proposal: *words-separated-by-dash.ext*  (all chars in lower case)
> 
> Rationale: Be consistent with hadoop config file names, i.e. hdfs-site.xml
> 
> Good example: kylin-server-log4j.properties
> Bad example: kylin_hive_conf.xml   (should be kylin-hive-conf.xml)
> 
> *Property Name Convention*
> 
> Proposal: *dot.separated.namespace.config-name-separated-by-dash*  (all
> chars in lower case)
> 
> Rationale: The dot separated prefix is for namespace, like java packages.
> The last level is like class name, but in lower case and separated by dash.
> The result is consistent with common hadoop config names, i.e.
> dfs.namenode.servicerpc-bind-host
> 
> Good example: kylin.metadata.url, kylin.storage.url
> Bad example: kylin.job.mapreduce.mapper.input.rows  (should be
> kyiln.job.mapreduce.mapper-input-rows)
> Bad example: kylin.cube.dimension.customEncodingFactories  (should be
> kylin.cube.dimension.custom-encoding-factories)
> 
> Please share your thoughts. Want to have a consensus with the majority
> first, then comes to implementation.
> 
> 
> Cheers
> Yang


Reply via email to