Re: PR title format
Sure. Let me start a vote. On Wed, Jan 8, 2020 at 3:00 PM tison wrote: > @yiheng > > It could be better we list several title format and start a voting thread > to see which one wins. For me these formats doesn't beat one from another, > but we should stick to a standard format. > > A new thread such as > > [VOTE] Commit title format > > option1: ... > option2: ... > > works for me. And of course the PR title keeps the same as the commit > title. > > Best, > tison. > > > tison 于2020年1月8日周三 下午2:57写道： > > > Thanks for your replies! > > > > I agree with Justin that it's better that we work out the best way for > the > > project and community while looking at what other projects do. > > > > @Saisai the thread seems focus on the title format of a pull request. > > Please narrow the scope of discussion. Also per @Junping 's suggestion, > > we can start a series of discussions about generally "how to contribute", > > "how to develop", "how to release" and collect the result on our wiki > > page. > > > > Best, > > tison. > > > > > > Justin Mclean 于2020年1月8日周三 上午11:57写道： > > > >> Hi, > >> > >> While it's good to look at what other projects do, please remember: > >> - They are top level projects and they may do things in a way for their > >> own particular reasons > >> - They may not be aware of recent changes in policy > >> - What works for one project may not be be the best for another project > >> or it’s community > >> - It best if you work out the best way for your project and community > and > >> what works for you and what doesn't > >> > >> Spark, while popular, is not an exemplary example for podlings to copy > >> for a number of reasons, so please take care when looking at these > projects. > >> > >> Thanks, > >> Justin > > > > >
Re: PR title format
@yiheng It could be better we list several title format and start a voting thread to see which one wins. For me these formats doesn't beat one from another, but we should stick to a standard format. A new thread such as [VOTE] Commit title format option1: ... option2: ... works for me. And of course the PR title keeps the same as the commit title. Best, tison. tison 于2020年1月8日周三 下午2:57写道： > Thanks for your replies! > > I agree with Justin that it's better that we work out the best way for the > project and community while looking at what other projects do. > > @Saisai the thread seems focus on the title format of a pull request. > Please narrow the scope of discussion. Also per @Junping 's suggestion, > we can start a series of discussions about generally "how to contribute", > "how to develop", "how to release" and collect the result on our wiki > page. > > Best, > tison. > > > Justin Mclean 于2020年1月8日周三 上午11:57写道： > >> Hi, >> >> While it's good to look at what other projects do, please remember: >> - They are top level projects and they may do things in a way for their >> own particular reasons >> - They may not be aware of recent changes in policy >> - What works for one project may not be be the best for another project >> or it’s community >> - It best if you work out the best way for your project and community and >> what works for you and what doesn't >> >> Spark, while popular, is not an exemplary example for podlings to copy >> for a number of reasons, so please take care when looking at these projects. >> >> Thanks, >> Justin > >
Re: PR title format
Thanks for your replies! I agree with Justin that it's better that we work out the best way for the project and community while looking at what other projects do. @Saisai the thread seems focus on the title format of a pull request. Please narrow the scope of discussion. Also per @Junping 's suggestion, we can start a series of discussions about generally "how to contribute", "how to develop", "how to release" and collect the result on our wiki page. Best, tison. Justin Mclean 于2020年1月8日周三 上午11:57写道： > Hi, > > While it's good to look at what other projects do, please remember: > - They are top level projects and they may do things in a way for their > own particular reasons > - They may not be aware of recent changes in policy > - What works for one project may not be be the best for another project or > it’s community > - It best if you work out the best way for your project and community and > what works for you and what doesn't > > Spark, while popular, is not an exemplary example for podlings to copy for > a number of reasons, so please take care when looking at these projects. > > Thanks, > Justin
Re: PR title format
Hi, While it's good to look at what other projects do, please remember: - They are top level projects and they may do things in a way for their own particular reasons - They may not be aware of recent changes in policy - What works for one project may not be be the best for another project or it’s community - It best if you work out the best way for your project and community and what works for you and what doesn't Spark, while popular, is not an exemplary example for podlings to copy for a number of reasons, so please take care when looking at these projects. Thanks, Justin
Re: PR title format
Thanks for bringing up discussions here, Yiheng! I think we need to discuss the whole workflow with more details (could be separated thread), such as "how to contribute", "how to commit". Without consensus and documented, it would be all messed up. Thanks, Junping Saisai Shao 于2020年1月8日周三 上午11:49写道： > I agreed, I think there should a wiki about "how to contribute". > > Also about the commit log, I think we should use the script to formalize > the commit log and use this to merge, not directly using GH button, one > consideration is to formalize the commit log, another is to avoid > additional merge commit. Here is what Spark community does ( > https://github.com/apache/spark/blob/master/dev/merge_spark_pr.py) . > > Thanks > Saisai > > Yiheng Wang 于2020年1月8日周三 上午11:38写道： > > > Hi community > > > > I've noticed that PR titles are little causal. For example: > > > >- optimization for delete unnecessary code > >- TUBEMQ-7: Using StringBuilder instead of StringBuffer in BaseResult > > > > Should we consider follow common Apache project pattern, like: > > [TUBEMQ-XXX] PR description > > or > > [TUBEMQ-XXX][Component] PR description > > > > Thanks > > Yiheng > > >
Re: PR title format
I agreed, I think there should a wiki about "how to contribute". Also about the commit log, I think we should use the script to formalize the commit log and use this to merge, not directly using GH button, one consideration is to formalize the commit log, another is to avoid additional merge commit. Here is what Spark community does ( https://github.com/apache/spark/blob/master/dev/merge_spark_pr.py) . Thanks Saisai Yiheng Wang 于2020年1月8日周三 上午11:38写道： > Hi community > > I've noticed that PR titles are little causal. For example: > >- optimization for delete unnecessary code >- TUBEMQ-7: Using StringBuilder instead of StringBuffer in BaseResult > > Should we consider follow common Apache project pattern, like: > [TUBEMQ-XXX] PR description > or > [TUBEMQ-XXX][Component] PR description > > Thanks > Yiheng >
Re: PR title format
Hi Yiheng, I agree that it helps we standardize the commit title. Actually the ZooKeeper community use ZOOKEEPER-XXX: (optional components) PR description And thus I use TUBEMQ-7: Using StringBuilder instead of StringBuffer in BaseResult I'm ok with your proposal but what's important IMO is document the decision both, at least, on 1. TubeMQ wiki page 2. CONTRIBUTE.md in repo (optional) 3. PULL_REQUEST_TEMPLATE in GitHub so that we notify our contributors once they try to submit a pull request. Best, tison. Yiheng Wang 于2020年1月8日周三 上午11:38写道： > Hi community > > I've noticed that PR titles are little causal. For example: > >- optimization for delete unnecessary code >- TUBEMQ-7: Using StringBuilder instead of StringBuffer in BaseResult > > Should we consider follow common Apache project pattern, like: > [TUBEMQ-XXX] PR description > or > [TUBEMQ-XXX][Component] PR description > > Thanks > Yiheng >
答复: PR title format(Internet mail)
I would prefer [TUBEMQ-][Component] PR description according to experiences in spark and parquet projects. -邮件原件- 发件人: Yiheng Wang [mailto:yihe...@gmail.com] 发送时间: 2020年1月8日 11:38 收件人: dev@tubemq.apache.org 抄送: 奕恒 王 主题: PR title format(Internet mail) Hi community I've noticed that PR titles are little causal. For example: - optimization for delete unnecessary code - TUBEMQ-7: Using StringBuilder instead of StringBuffer in BaseResult Should we consider follow common Apache project pattern, like: [TUBEMQ-XXX] PR description or [TUBEMQ-XXX][Component] PR description Thanks Yiheng
PR title format
Hi community I've noticed that PR titles are little causal. For example: - optimization for delete unnecessary code - TUBEMQ-7: Using StringBuilder instead of StringBuffer in BaseResult Should we consider follow common Apache project pattern, like: [TUBEMQ-XXX] PR description or [TUBEMQ-XXX][Component] PR description Thanks Yiheng
