You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@pulsar.apache.org by Yu <li...@apache.org> on 2022/08/17 03:15:53 UTC
[Discussion] PIP 198 - How to define [type] and [scope]?
Hi team,
For PIP 198: Standardize PR Naming Convention using GitHub Actions [1]
How to define [type] and [scope]? Do these abbreviations LGTY?
*[Guide] Pulsar Pull Request Naming Convention* [2] contains everything
about the definition. Feel free to check and comment!
~~~~~~~~~~
TL;DR
PR title format: [type][scope] Summary [3]
~~~~~~~~~~
[type]
1. Definition: what actions do you take?
2. It must be one of the following:
- feat (abbr for "feature")
- improve
- fix
- cleanup
- refactor
- revert
~~~~~~~~~~
[scope]
1. Definition: where do you make changes?
2. It must be one of the following:
- admin (changes to pulsar-admin, REST API, Java admin API)
- broker
- io
- deploy
- dep (abbr for dependency)
- fcn (abbr for function)
- monitor
- pkg (abbr for package)
- proxy
- schema
- sec (abbr for security)
- sql
- ts (abbr for tiered storage)
- tool
- txn (abbr for transaction)
- java (changes to Java client)
- cpp (changes to C++ client)
- py (changes to Python client)
- ws (changes to WebSocket)
- rest (changes to REST)
- test
- ci
- workflow
- build
- misc (abbr for miscellaneous)
- doc
- blog
- site (abbr for website)
~~~~~~~~~~
Besides, many developers have different opinions on the following aspects.
What's your writing preference?
- Submit breaking changes
[feat][broker]! Support xx
- Submit PIP changes
[feat][broker] PIP-198: Support xx
- Cherry pick changes [4]
Choice A: [fix][broker][branch-2.9] xxx
Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in the
PR description.
~~~~~~~~~~
Feel free to comment and make your voice heard. Go vote! Thank you!
[1]
https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
[2] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
[3]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
[4]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
Yu
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Jiuming Tao <jm...@streamnative.io.INVALID>.
A
A
Thanks
Tao Jiuming
> 2022年8月22日 下午12:47，Yu <li...@apache.org> 写道：
>
> Hi developers,
>
> Two quick questions need your vote!
>
> Which do you prefer?
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 1. Use "branch" or "BP"?
>
> Choice A: [fix][broker][branch-2.9] xxx
> Choice B: [fix][broker][BP-2.9] xxx
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 2. for the [scope], use "misc" or "chore"? [1]
>
> Choice A: misc
> Choice B: chore
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Thank you all!
>
> [1]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.58q1qxhu7pio
>
> Yu
>
> On Mon, Aug 22, 2022 at 12:44 PM Yu <li...@apache.org> wrote:
>
>> Hi tison,
>>
>> Thanks for your suggestions! We have several questions on [build]:
>>
>>> build - all things related to the build system, including tools,
>> deployment logic, maven changes, packaging logics, docker image, build
>> scripts.
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 1. "tools"
>>
>> What do you refer to? Plugins?
>>
>> Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
>> We're considering to rename it to [cli] since:
>> a. "cli" is more clear and short
>> b. Save the word "tool" for future use
>>
>> Does it make sense?
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 2. "deployment logic"
>>
>> Seems that it's an obsolete module and has not been updated for a long
>> while.
>> If so, can we ignore this?
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 3. Does "packaging logics" belong to [admin]? [2]
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 4. How about defining [build] refer to the following?
>>
>> - Dependency (Maven)
>>
>> In this way, we do not have the scope [dependency] since the changes to
>> dependency belong to [build].
>>
>> - Docker
>>
>> - Build or release script
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> Thank you for your reply!
>>
>> [1]
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.khz275ok35u5
>> [2]
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
>>
>> Yu and Zixuan
>>
>> On Mon, Aug 22, 2022 at 12:40 PM Yu <li...@apache.org> wrote:
>>
>>> Thank you tison and Zixuan!
>>>
>>> Agree on the following aspects:
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> # 1. Remove 3 [scope]s
>>>
>>> - Remove [workflow] since it can be replaced with other scopes
>>> eg.
>>> "[feat][workflow] Add instructions for previewing website changes"
>>> can be written as
>>> "[feat][doc] Add instructions for previewing website changes"
>>>
>>> - Remove [depoly] since changes to deployment can be represented by other
>>> [scope]s.
>>>
>>> - Remove [pkg]since it refers to package API [1], which belongs to
>>> [admin].
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> # 2. Update 4 [scope]s
>>>
>>> - Add [meta], which refers to changes to metadata.
>>>
>>> - Add [storage], which refers to changes to managed ledger.
>>>
>>> - Rename [ts] to [offloaded], which refers to changes to tiered storage.
>>>
>>> - Rename [func] to [fn], which refers to changes to function.
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> # 3. Remain the same
>>>
>>> These formats are fine to go:
>>>
>>> - Submit breaking changes
>>> [feat][broker]! Support xx
>>>
>>> - Submit PIP changes
>>> [feat][broker] PIP-198: Support xx
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> Feel free to comment, thank you!
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> [1] https://pulsar.apache.org/docs/next/admin-api-packages
>>>
>>> Yu and Zixuan
>>>
>>> On Fri, Aug 19, 2022 at 6:21 PM Zixuan Liu <no...@gmail.com> wrote:
>>>
>>>> +1 for fcn -> fn
>>>> +1 for ts -> offloader
>>>>
>>>> +1 * ci - CI workflow changes or debugging.
>>>> +1 * build - all things related to the build system, including tools,
>>>> deployment logic, maven changes, packaging logics, docker image,
>>>> buildscripts.
>>>>
>>>> `pkg` should belong to the `admin` scope, so suggest using the `admin`
>>>> instead `pkg`.
>>>>
>>>> `tool` is pulsar-admin, pulsar, pulsar-client, and so on cli, so keep
>>>> using
>>>> the `tool`.
>>>>
>>>> deploy should belong to the `build` scope`, so suggest using the `build`
>>>> instead `deploy`.
>>>>
>>>>
>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:46写道：
>>>>
>>>>> BTW, how can I sort changes for the metadata store?
>>>>>
>>>>> Best,
>>>>> tison.
>>>>>
>>>>>
>>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:44写道：
>>>>>
>>>>>> To proposal a workable solution, I suggest:
>>>>>>
>>>>>> replace
>>>>>>
>>>>>> * pkg
>>>>>> * tool
>>>>>> * deploy
>>>>>> * ci
>>>>>> * workflow
>>>>>> * build
>>>>>>
>>>>>> with
>>>>>>
>>>>>> * ci - CI workflow changes or debugging.
>>>>>> * build - all things related to the build system, including tools,
>>>>>> deployment logic, maven changes, packaging logics, docker image,
>>>> build
>>>>>> scripts.
>>>>>>
>>>>>> Best,
>>>>>> tison.
>>>>>>
>>>>>>
>>>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
>>>>>>
>>>>>>>> I intended to mean changes to "process / standard / guide" [2]
>>>> rather
>>>>>>> than "CI workflow", but it still causes confusion.
>>>>>>>
>>>>>>> How can a PR be relevant to these things? I think the result should
>>>> be
>>>>>>> either CI workflow changes or document updates. We don't need a
>>>>> dedicated
>>>>>>> "workflow" in such situations.
>>>>>>>
>>>>>>>> build system or external dependencies.
>>>>>>>
>>>>>>> So, it overlaps with deps. While I can regard it as
>>>> Maven/Docker/Build
>>>>>>> script related changes, we may not have "pkg", "tool", "deploy"
>>>> that can
>>>>>>> overlap with this.
>>>>>>>
>>>>>>> Best,
>>>>>>> tison.
>>>>>>>
>>>>>>>
>>>>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
>>>>>>>
>>>>>>>> As for the type candidates:
>>>>>>>>
>>>>>>>> LGTM. No comment here.
>>>>>>>>
>>>>>>>> As for the scope candidates:
>>>>>>>>
>>>>>>>> +1 for dep -> deps
>>>>>>>> +1 for fcn -> fn
>>>>>>>> Among most communities and language conventions, the abbr of
>>>> function
>>>>>>>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd
>>>> prefer
>>>>> the
>>>>>>>> short one, fn.
>>>>>>>> +1 for ts -> offloader
>>>>>>>> If I get it right, tiered storage is offloader. We can save one
>>>> word
>>>>>>>> while keeping semantic.
>>>>>>>>
>>>>>>>> I don't know clearly what is:
>>>>>>>> * pkg
>>>>>>>> * tool
>>>>>>>> * deploy
>>>>>>>> * ci
>>>>>>>> * workflow
>>>>>>>> * build
>>>>>>>> They look quite similar or overlapping.
>>>>>>>>
>>>>>>>> Rest LGTM.
>>>>>>>>
>>>>>>>> As for the remaining issues:
>>>>>>>>
>>>>>>>> - Submit breaking changes
>>>>>>>> [feat][broker]! Support xx
>>>>>>>>
>>>>>>>> This is fine. Since we don't verify what follows the [type][scope]
>>>>>>>> section, it doesn't block the proposal.
>>>>>>>>
>>>>>>>> - Submit PIP changes
>>>>>>>> [feat][broker] PIP-198: Support xx
>>>>>>>>
>>>>>>>> The same as before. Contributors can name whatever they like. We
>>>> don't
>>>>>>>> set too complex rules.
>>>>>>>>
>>>>>>>> - Cherry pick changes [4]
>>>>>>>> Choice A: [fix][broker][branch-2.9] xxx
>>>>>>>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to
>>>> branch-2.9" in
>>>>>>>> the
>>>>>>>> PR description.
>>>>>>>>
>>>>>>>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how
>>>> the
>>>>>>>> Flink community does. BP means backport. But yes, it's not a
>>>>> requirement
>>>>>>>> but a suggestion.
>>>>>>>>
>>>>>>>>
>>>>>>>> Best,
>>>>>>>> tison.
>>>>>>>>
>>>>>>>
>>>>>
>>>>
>>>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by PengHui Li <pe...@apache.org>.
+1
Penghui
On Tue, Aug 23, 2022 at 6:04 PM Yu <li...@apache.org> wrote:
> Hi team,
>
> Many thanks for your feedback! We've adjusted the convention based on your
> suggestions!
>
> Below is a brief summary of what we have reached a consensus on:
>
> ~~~~~~~~~~~~~~~~
>
> 1. Convention
>
> Continue to follow our existing convention (it's customized on Agular) [1]
>
> ~~~~~~~~~~~~~~~~
>
> 2. Definition
>
> [type] must be one of the following:
> - feat (abbr for "feature")
> - improve
> - fix
> - cleanup
> - refactor
> - revert
>
> [scope] must be one of the following:
> - admin
> - broker
> - cli (changes to CLI tools)
> - io
> - fn (abbr for "function")
> - meta (abbr for "metadata")
> - monitor
> - proxy
> - schema
> - sec (abbr for "security")
> - sql
> - storage
> - offload (changes to tiered storage)
> - txn
> - java
> - cpp
> - py
> - ws (changes to WebSocket)
> - test (changes to code tests)
> - ci (changes to CI workflow)
> - build (changes to dependencies, docker, build or release script)
> - misc
> - doc
> - blog
> - site
>
> For full details, see [Guide] Pulsar Pull Request Naming Convention [2]
>
> ~~~~~~~~~~~~~~~~
>
> If you have any concerns, feel free to comment before 13:00 August 25 (UTC
> +8).
>
> We'll start implementing it if there is no objection after that time.
>
> Thank you!
>
> ~~~~~~~~~~~~~~~~
>
> [1] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> [2]
>
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
>
> Yu and mangoGoForward
>
> On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
>
> > Hi Jiuming, Yunze, tison,
> > Thanks for your vote!
> >
> > ~~~~~~~~~~~~~~~~
> >
> > Hi tison,
> >
> > > "packaging logics"
> > > For example, build the docker image, build & publish shell scripts.
> >
> > If you refer to these changes, they belong to [build] scope.
> >
> > Yu and Zixuan
> >
> > On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com> wrote:
> >
> >> Hi Yu,
> >>
> >> Reply inline:
> >>
> >> > Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
> >> > We're considering to rename it to [cli] since:
> >>
> >> Make sense.
> >>
> >> > "deployment logic" If so, can we ignore this?
> >>
> >> I saw you already remove [deploy] scope. No comment here. It should be
> >> fine.
> >>
> >> > "packaging logics"
> >>
> >> For example, build the docker image, build & publish shell scripts.
> >>
> >> > How about defining [build] refer to the following?
> >>
> >> Make sense.
> >>
> >> > Two quick questions need your vote!
> >>
> >> To save letters, B & A.
> >>
> >> Best,
> >> tison.
> >>
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Thank you tison!
We don't explicitly set the rules for issue titles and force ppl to follow.
Just suggest you can follow the same rule to write issue titles if you
ensure the involved [type] and [scope] like this example [1].
Otherwise, you can write as usual.
[1] https://github.com/apache/pulsar/issues/14928
Yu
On Thu, Aug 25, 2022 at 1:16 PM tison <wa...@gmail.com> wrote:
> Anyway, it's a separate topic to discuss. If you want to discuss issue
> types and whether to label components, please start another thread.
>
> Best,
> tison.
>
>
> tison <wa...@gmail.com> 于2022年8月25日周四 13:12写道：
>
> > From current issue templates, we already sort issues into bug reports,
> > improvements, doc changes, flaky tests, and PIPs. They're types. [type]
> and
> > [component] described here are applied to commit messages, not for
> issues.
> >
> > For components, we may encourage contributors to try their best to sort
> > out related components, but it's generally hard to do. I report a bug,
> how
> > can I know which components are related? It is required I have to dig it
> > out?
> >
> > Best,
> > tison.
> >
> >
> > tison <wa...@gmail.com> 于2022年8月25日周四 13:08写道：
> >
> >> > Agree with applying the same rules ( [type] [scope] summary) for
> >> writing issue titles.
> >>
> >> It cannot be guarded by check so I think it only increases contributors'
> >> overhead.
> >>
> >> Instead, we can try to find out some integration if we can use the
> GitHub
> >> issue forms dropdown widget to allow contributors to tag the issue.
> >>
> >> I don't know whether it's possible, but it's better than setting up
> title
> >> rules. I can foresee that it's seldomly followed.
> >>
> >> Best,
> >> tison.
> >>
> >>
> >> Liu Yu <li...@apache.org> 于2022年8月25日周四 12:59写道：
> >>
> >>> Thanks Max!
> >>>
> >>> Agree with applying the same rules ( [type] [scope] summary) for
> writing
> >>> issue titles.
> >>>
> >>> On 2022/08/25 02:48:51 Max Xu wrote:
> >>> > LGTM.
> >>> >
> >>> > And I think we should also update our issue templates.
> >>> >
> >>> > Best,
> >>> > Max Xu
> >>> >
> >>> >
> >>> > On Tue, Aug 23, 2022 at 6:04 PM Yu <li...@apache.org> wrote:
> >>> >
> >>> > > Hi team,
> >>> > >
> >>> > > Many thanks for your feedback! We've adjusted the convention based
> >>> on your
> >>> > > suggestions!
> >>> > >
> >>> > > Below is a brief summary of what we have reached a consensus on:
> >>> > >
> >>> > > ~~~~~~~~~~~~~~~~
> >>> > >
> >>> > > 1. Convention
> >>> > >
> >>> > > Continue to follow our existing convention (it's customized on
> >>> Agular) [1]
> >>> > >
> >>> > > ~~~~~~~~~~~~~~~~
> >>> > >
> >>> > > 2. Definition
> >>> > >
> >>> > > [type] must be one of the following:
> >>> > > - feat (abbr for "feature")
> >>> > > - improve
> >>> > > - fix
> >>> > > - cleanup
> >>> > > - refactor
> >>> > > - revert
> >>> > >
> >>> > > [scope] must be one of the following:
> >>> > > - admin
> >>> > > - broker
> >>> > > - cli (changes to CLI tools)
> >>> > > - io
> >>> > > - fn (abbr for "function")
> >>> > > - meta (abbr for "metadata")
> >>> > > - monitor
> >>> > > - proxy
> >>> > > - schema
> >>> > > - sec (abbr for "security")
> >>> > > - sql
> >>> > > - storage
> >>> > > - offload (changes to tiered storage)
> >>> > > - txn
> >>> > > - java
> >>> > > - cpp
> >>> > > - py
> >>> > > - ws (changes to WebSocket)
> >>> > > - test (changes to code tests)
> >>> > > - ci (changes to CI workflow)
> >>> > > - build (changes to dependencies, docker, build or release script)
> >>> > > - misc
> >>> > > - doc
> >>> > > - blog
> >>> > > - site
> >>> > >
> >>> > > For full details, see [Guide] Pulsar Pull Request Naming Convention
> >>> [2]
> >>> > >
> >>> > > ~~~~~~~~~~~~~~~~
> >>> > >
> >>> > > If you have any concerns, feel free to comment before 13:00 August
> >>> 25 (UTC
> >>> > > +8).
> >>> > >
> >>> > > We'll start implementing it if there is no objection after that
> time.
> >>> > >
> >>> > > Thank you!
> >>> > >
> >>> > > ~~~~~~~~~~~~~~~~
> >>> > >
> >>> > > [1]
> https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> >>> > > [2]
> >>> > >
> >>> > >
> >>>
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> >>> > >
> >>> > > Yu and mangoGoForward
> >>> > >
> >>> > > On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
> >>> > >
> >>> > > > Hi Jiuming, Yunze, tison,
> >>> > > > Thanks for your vote!
> >>> > > >
> >>> > > > ~~~~~~~~~~~~~~~~
> >>> > > >
> >>> > > > Hi tison,
> >>> > > >
> >>> > > > > "packaging logics"
> >>> > > > > For example, build the docker image, build & publish shell
> >>> scripts.
> >>> > > >
> >>> > > > If you refer to these changes, they belong to [build] scope.
> >>> > > >
> >>> > > > Yu and Zixuan
> >>> > > >
> >>> > > > On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com>
> >>> wrote:
> >>> > > >
> >>> > > >> Hi Yu,
> >>> > > >>
> >>> > > >> Reply inline:
> >>> > > >>
> >>> > > >> > Besides, the existing scope, [tool], refers to Pulsar CLI
> tools
> >>> [1].
> >>> > > >> > We're considering to rename it to [cli] since:
> >>> > > >>
> >>> > > >> Make sense.
> >>> > > >>
> >>> > > >> > "deployment logic" If so, can we ignore this?
> >>> > > >>
> >>> > > >> I saw you already remove [deploy] scope. No comment here. It
> >>> should be
> >>> > > >> fine.
> >>> > > >>
> >>> > > >> > "packaging logics"
> >>> > > >>
> >>> > > >> For example, build the docker image, build & publish shell
> >>> scripts.
> >>> > > >>
> >>> > > >> > How about defining [build] refer to the following?
> >>> > > >>
> >>> > > >> Make sense.
> >>> > > >>
> >>> > > >> > Two quick questions need your vote!
> >>> > > >>
> >>> > > >> To save letters, B & A.
> >>> > > >>
> >>> > > >> Best,
> >>> > > >> tison.
> >>> > > >>
> >>> > > >
> >>> > >
> >>> >
> >>>
> >>
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
Anyway, it's a separate topic to discuss. If you want to discuss issue
types and whether to label components, please start another thread.
Best,
tison.
tison <wa...@gmail.com> 于2022年8月25日周四 13:12写道：
> From current issue templates, we already sort issues into bug reports,
> improvements, doc changes, flaky tests, and PIPs. They're types. [type] and
> [component] described here are applied to commit messages, not for issues.
>
> For components, we may encourage contributors to try their best to sort
> out related components, but it's generally hard to do. I report a bug, how
> can I know which components are related? It is required I have to dig it
> out?
>
> Best,
> tison.
>
>
> tison <wa...@gmail.com> 于2022年8月25日周四 13:08写道：
>
>> > Agree with applying the same rules ( [type] [scope] summary) for
>> writing issue titles.
>>
>> It cannot be guarded by check so I think it only increases contributors'
>> overhead.
>>
>> Instead, we can try to find out some integration if we can use the GitHub
>> issue forms dropdown widget to allow contributors to tag the issue.
>>
>> I don't know whether it's possible, but it's better than setting up title
>> rules. I can foresee that it's seldomly followed.
>>
>> Best,
>> tison.
>>
>>
>> Liu Yu <li...@apache.org> 于2022年8月25日周四 12:59写道：
>>
>>> Thanks Max!
>>>
>>> Agree with applying the same rules ( [type] [scope] summary) for writing
>>> issue titles.
>>>
>>> On 2022/08/25 02:48:51 Max Xu wrote:
>>> > LGTM.
>>> >
>>> > And I think we should also update our issue templates.
>>> >
>>> > Best,
>>> > Max Xu
>>> >
>>> >
>>> > On Tue, Aug 23, 2022 at 6:04 PM Yu <li...@apache.org> wrote:
>>> >
>>> > > Hi team,
>>> > >
>>> > > Many thanks for your feedback! We've adjusted the convention based
>>> on your
>>> > > suggestions!
>>> > >
>>> > > Below is a brief summary of what we have reached a consensus on:
>>> > >
>>> > > ~~~~~~~~~~~~~~~~
>>> > >
>>> > > 1. Convention
>>> > >
>>> > > Continue to follow our existing convention (it's customized on
>>> Agular) [1]
>>> > >
>>> > > ~~~~~~~~~~~~~~~~
>>> > >
>>> > > 2. Definition
>>> > >
>>> > > [type] must be one of the following:
>>> > > - feat (abbr for "feature")
>>> > > - improve
>>> > > - fix
>>> > > - cleanup
>>> > > - refactor
>>> > > - revert
>>> > >
>>> > > [scope] must be one of the following:
>>> > > - admin
>>> > > - broker
>>> > > - cli (changes to CLI tools)
>>> > > - io
>>> > > - fn (abbr for "function")
>>> > > - meta (abbr for "metadata")
>>> > > - monitor
>>> > > - proxy
>>> > > - schema
>>> > > - sec (abbr for "security")
>>> > > - sql
>>> > > - storage
>>> > > - offload (changes to tiered storage)
>>> > > - txn
>>> > > - java
>>> > > - cpp
>>> > > - py
>>> > > - ws (changes to WebSocket)
>>> > > - test (changes to code tests)
>>> > > - ci (changes to CI workflow)
>>> > > - build (changes to dependencies, docker, build or release script)
>>> > > - misc
>>> > > - doc
>>> > > - blog
>>> > > - site
>>> > >
>>> > > For full details, see [Guide] Pulsar Pull Request Naming Convention
>>> [2]
>>> > >
>>> > > ~~~~~~~~~~~~~~~~
>>> > >
>>> > > If you have any concerns, feel free to comment before 13:00 August
>>> 25 (UTC
>>> > > +8).
>>> > >
>>> > > We'll start implementing it if there is no objection after that time.
>>> > >
>>> > > Thank you!
>>> > >
>>> > > ~~~~~~~~~~~~~~~~
>>> > >
>>> > > [1] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
>>> > > [2]
>>> > >
>>> > >
>>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
>>> > >
>>> > > Yu and mangoGoForward
>>> > >
>>> > > On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
>>> > >
>>> > > > Hi Jiuming, Yunze, tison,
>>> > > > Thanks for your vote!
>>> > > >
>>> > > > ~~~~~~~~~~~~~~~~
>>> > > >
>>> > > > Hi tison,
>>> > > >
>>> > > > > "packaging logics"
>>> > > > > For example, build the docker image, build & publish shell
>>> scripts.
>>> > > >
>>> > > > If you refer to these changes, they belong to [build] scope.
>>> > > >
>>> > > > Yu and Zixuan
>>> > > >
>>> > > > On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com>
>>> wrote:
>>> > > >
>>> > > >> Hi Yu,
>>> > > >>
>>> > > >> Reply inline:
>>> > > >>
>>> > > >> > Besides, the existing scope, [tool], refers to Pulsar CLI tools
>>> [1].
>>> > > >> > We're considering to rename it to [cli] since:
>>> > > >>
>>> > > >> Make sense.
>>> > > >>
>>> > > >> > "deployment logic" If so, can we ignore this?
>>> > > >>
>>> > > >> I saw you already remove [deploy] scope. No comment here. It
>>> should be
>>> > > >> fine.
>>> > > >>
>>> > > >> > "packaging logics"
>>> > > >>
>>> > > >> For example, build the docker image, build & publish shell
>>> scripts.
>>> > > >>
>>> > > >> > How about defining [build] refer to the following?
>>> > > >>
>>> > > >> Make sense.
>>> > > >>
>>> > > >> > Two quick questions need your vote!
>>> > > >>
>>> > > >> To save letters, B & A.
>>> > > >>
>>> > > >> Best,
>>> > > >> tison.
>>> > > >>
>>> > > >
>>> > >
>>> >
>>>
>>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
From current issue templates, we already sort issues into bug reports,
improvements, doc changes, flaky tests, and PIPs. They're types. [type] and
[component] described here are applied to commit messages, not for issues.
For components, we may encourage contributors to try their best to sort out
related components, but it's generally hard to do. I report a bug, how can
I know which components are related? It is required I have to dig it out?
Best,
tison.
tison <wa...@gmail.com> 于2022年8月25日周四 13:08写道：
> > Agree with applying the same rules ( [type] [scope] summary) for
> writing issue titles.
>
> It cannot be guarded by check so I think it only increases contributors'
> overhead.
>
> Instead, we can try to find out some integration if we can use the GitHub
> issue forms dropdown widget to allow contributors to tag the issue.
>
> I don't know whether it's possible, but it's better than setting up title
> rules. I can foresee that it's seldomly followed.
>
> Best,
> tison.
>
>
> Liu Yu <li...@apache.org> 于2022年8月25日周四 12:59写道：
>
>> Thanks Max!
>>
>> Agree with applying the same rules ( [type] [scope] summary) for writing
>> issue titles.
>>
>> On 2022/08/25 02:48:51 Max Xu wrote:
>> > LGTM.
>> >
>> > And I think we should also update our issue templates.
>> >
>> > Best,
>> > Max Xu
>> >
>> >
>> > On Tue, Aug 23, 2022 at 6:04 PM Yu <li...@apache.org> wrote:
>> >
>> > > Hi team,
>> > >
>> > > Many thanks for your feedback! We've adjusted the convention based on
>> your
>> > > suggestions!
>> > >
>> > > Below is a brief summary of what we have reached a consensus on:
>> > >
>> > > ~~~~~~~~~~~~~~~~
>> > >
>> > > 1. Convention
>> > >
>> > > Continue to follow our existing convention (it's customized on
>> Agular) [1]
>> > >
>> > > ~~~~~~~~~~~~~~~~
>> > >
>> > > 2. Definition
>> > >
>> > > [type] must be one of the following:
>> > > - feat (abbr for "feature")
>> > > - improve
>> > > - fix
>> > > - cleanup
>> > > - refactor
>> > > - revert
>> > >
>> > > [scope] must be one of the following:
>> > > - admin
>> > > - broker
>> > > - cli (changes to CLI tools)
>> > > - io
>> > > - fn (abbr for "function")
>> > > - meta (abbr for "metadata")
>> > > - monitor
>> > > - proxy
>> > > - schema
>> > > - sec (abbr for "security")
>> > > - sql
>> > > - storage
>> > > - offload (changes to tiered storage)
>> > > - txn
>> > > - java
>> > > - cpp
>> > > - py
>> > > - ws (changes to WebSocket)
>> > > - test (changes to code tests)
>> > > - ci (changes to CI workflow)
>> > > - build (changes to dependencies, docker, build or release script)
>> > > - misc
>> > > - doc
>> > > - blog
>> > > - site
>> > >
>> > > For full details, see [Guide] Pulsar Pull Request Naming Convention
>> [2]
>> > >
>> > > ~~~~~~~~~~~~~~~~
>> > >
>> > > If you have any concerns, feel free to comment before 13:00 August 25
>> (UTC
>> > > +8).
>> > >
>> > > We'll start implementing it if there is no objection after that time.
>> > >
>> > > Thank you!
>> > >
>> > > ~~~~~~~~~~~~~~~~
>> > >
>> > > [1] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
>> > > [2]
>> > >
>> > >
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
>> > >
>> > > Yu and mangoGoForward
>> > >
>> > > On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
>> > >
>> > > > Hi Jiuming, Yunze, tison,
>> > > > Thanks for your vote!
>> > > >
>> > > > ~~~~~~~~~~~~~~~~
>> > > >
>> > > > Hi tison,
>> > > >
>> > > > > "packaging logics"
>> > > > > For example, build the docker image, build & publish shell
>> scripts.
>> > > >
>> > > > If you refer to these changes, they belong to [build] scope.
>> > > >
>> > > > Yu and Zixuan
>> > > >
>> > > > On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com> wrote:
>> > > >
>> > > >> Hi Yu,
>> > > >>
>> > > >> Reply inline:
>> > > >>
>> > > >> > Besides, the existing scope, [tool], refers to Pulsar CLI tools
>> [1].
>> > > >> > We're considering to rename it to [cli] since:
>> > > >>
>> > > >> Make sense.
>> > > >>
>> > > >> > "deployment logic" If so, can we ignore this?
>> > > >>
>> > > >> I saw you already remove [deploy] scope. No comment here. It
>> should be
>> > > >> fine.
>> > > >>
>> > > >> > "packaging logics"
>> > > >>
>> > > >> For example, build the docker image, build & publish shell scripts.
>> > > >>
>> > > >> > How about defining [build] refer to the following?
>> > > >>
>> > > >> Make sense.
>> > > >>
>> > > >> > Two quick questions need your vote!
>> > > >>
>> > > >> To save letters, B & A.
>> > > >>
>> > > >> Best,
>> > > >> tison.
>> > > >>
>> > > >
>> > >
>> >
>>
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
> Agree with applying the same rules ( [type] [scope] summary) for writing
issue titles.
It cannot be guarded by check so I think it only increases contributors'
overhead.
Instead, we can try to find out some integration if we can use the GitHub
issue forms dropdown widget to allow contributors to tag the issue.
I don't know whether it's possible, but it's better than setting up title
rules. I can foresee that it's seldomly followed.
Best,
tison.
Liu Yu <li...@apache.org> 于2022年8月25日周四 12:59写道：
> Thanks Max!
>
> Agree with applying the same rules ( [type] [scope] summary) for writing
> issue titles.
>
> On 2022/08/25 02:48:51 Max Xu wrote:
> > LGTM.
> >
> > And I think we should also update our issue templates.
> >
> > Best,
> > Max Xu
> >
> >
> > On Tue, Aug 23, 2022 at 6:04 PM Yu <li...@apache.org> wrote:
> >
> > > Hi team,
> > >
> > > Many thanks for your feedback! We've adjusted the convention based on
> your
> > > suggestions!
> > >
> > > Below is a brief summary of what we have reached a consensus on:
> > >
> > > ~~~~~~~~~~~~~~~~
> > >
> > > 1. Convention
> > >
> > > Continue to follow our existing convention (it's customized on Agular)
> [1]
> > >
> > > ~~~~~~~~~~~~~~~~
> > >
> > > 2. Definition
> > >
> > > [type] must be one of the following:
> > > - feat (abbr for "feature")
> > > - improve
> > > - fix
> > > - cleanup
> > > - refactor
> > > - revert
> > >
> > > [scope] must be one of the following:
> > > - admin
> > > - broker
> > > - cli (changes to CLI tools)
> > > - io
> > > - fn (abbr for "function")
> > > - meta (abbr for "metadata")
> > > - monitor
> > > - proxy
> > > - schema
> > > - sec (abbr for "security")
> > > - sql
> > > - storage
> > > - offload (changes to tiered storage)
> > > - txn
> > > - java
> > > - cpp
> > > - py
> > > - ws (changes to WebSocket)
> > > - test (changes to code tests)
> > > - ci (changes to CI workflow)
> > > - build (changes to dependencies, docker, build or release script)
> > > - misc
> > > - doc
> > > - blog
> > > - site
> > >
> > > For full details, see [Guide] Pulsar Pull Request Naming Convention [2]
> > >
> > > ~~~~~~~~~~~~~~~~
> > >
> > > If you have any concerns, feel free to comment before 13:00 August 25
> (UTC
> > > +8).
> > >
> > > We'll start implementing it if there is no objection after that time.
> > >
> > > Thank you!
> > >
> > > ~~~~~~~~~~~~~~~~
> > >
> > > [1] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > > [2]
> > >
> > >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > >
> > > Yu and mangoGoForward
> > >
> > > On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
> > >
> > > > Hi Jiuming, Yunze, tison,
> > > > Thanks for your vote!
> > > >
> > > > ~~~~~~~~~~~~~~~~
> > > >
> > > > Hi tison,
> > > >
> > > > > "packaging logics"
> > > > > For example, build the docker image, build & publish shell scripts.
> > > >
> > > > If you refer to these changes, they belong to [build] scope.
> > > >
> > > > Yu and Zixuan
> > > >
> > > > On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com> wrote:
> > > >
> > > >> Hi Yu,
> > > >>
> > > >> Reply inline:
> > > >>
> > > >> > Besides, the existing scope, [tool], refers to Pulsar CLI tools
> [1].
> > > >> > We're considering to rename it to [cli] since:
> > > >>
> > > >> Make sense.
> > > >>
> > > >> > "deployment logic" If so, can we ignore this?
> > > >>
> > > >> I saw you already remove [deploy] scope. No comment here. It should
> be
> > > >> fine.
> > > >>
> > > >> > "packaging logics"
> > > >>
> > > >> For example, build the docker image, build & publish shell scripts.
> > > >>
> > > >> > How about defining [build] refer to the following?
> > > >>
> > > >> Make sense.
> > > >>
> > > >> > Two quick questions need your vote!
> > > >>
> > > >> To save letters, B & A.
> > > >>
> > > >> Best,
> > > >> tison.
> > > >>
> > > >
> > >
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Liu Yu <li...@apache.org>.
Thanks Max!
Agree with applying the same rules ( [type] [scope] summary) for writing issue titles.
On 2022/08/25 02:48:51 Max Xu wrote:
> LGTM.
>
> And I think we should also update our issue templates.
>
> Best,
> Max Xu
>
>
> On Tue, Aug 23, 2022 at 6:04 PM Yu <li...@apache.org> wrote:
>
> > Hi team,
> >
> > Many thanks for your feedback! We've adjusted the convention based on your
> > suggestions!
> >
> > Below is a brief summary of what we have reached a consensus on:
> >
> > ~~~~~~~~~~~~~~~~
> >
> > 1. Convention
> >
> > Continue to follow our existing convention (it's customized on Agular) [1]
> >
> > ~~~~~~~~~~~~~~~~
> >
> > 2. Definition
> >
> > [type] must be one of the following:
> > - feat (abbr for "feature")
> > - improve
> > - fix
> > - cleanup
> > - refactor
> > - revert
> >
> > [scope] must be one of the following:
> > - admin
> > - broker
> > - cli (changes to CLI tools)
> > - io
> > - fn (abbr for "function")
> > - meta (abbr for "metadata")
> > - monitor
> > - proxy
> > - schema
> > - sec (abbr for "security")
> > - sql
> > - storage
> > - offload (changes to tiered storage)
> > - txn
> > - java
> > - cpp
> > - py
> > - ws (changes to WebSocket)
> > - test (changes to code tests)
> > - ci (changes to CI workflow)
> > - build (changes to dependencies, docker, build or release script)
> > - misc
> > - doc
> > - blog
> > - site
> >
> > For full details, see [Guide] Pulsar Pull Request Naming Convention [2]
> >
> > ~~~~~~~~~~~~~~~~
> >
> > If you have any concerns, feel free to comment before 13:00 August 25 (UTC
> > +8).
> >
> > We'll start implementing it if there is no objection after that time.
> >
> > Thank you!
> >
> > ~~~~~~~~~~~~~~~~
> >
> > [1] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > [2]
> >
> > https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> >
> > Yu and mangoGoForward
> >
> > On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
> >
> > > Hi Jiuming, Yunze, tison,
> > > Thanks for your vote!
> > >
> > > ~~~~~~~~~~~~~~~~
> > >
> > > Hi tison,
> > >
> > > > "packaging logics"
> > > > For example, build the docker image, build & publish shell scripts.
> > >
> > > If you refer to these changes, they belong to [build] scope.
> > >
> > > Yu and Zixuan
> > >
> > > On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com> wrote:
> > >
> > >> Hi Yu,
> > >>
> > >> Reply inline:
> > >>
> > >> > Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
> > >> > We're considering to rename it to [cli] since:
> > >>
> > >> Make sense.
> > >>
> > >> > "deployment logic" If so, can we ignore this?
> > >>
> > >> I saw you already remove [deploy] scope. No comment here. It should be
> > >> fine.
> > >>
> > >> > "packaging logics"
> > >>
> > >> For example, build the docker image, build & publish shell scripts.
> > >>
> > >> > How about defining [build] refer to the following?
> > >>
> > >> Make sense.
> > >>
> > >> > Two quick questions need your vote!
> > >>
> > >> To save letters, B & A.
> > >>
> > >> Best,
> > >> tison.
> > >>
> > >
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Max Xu <ma...@gmail.com>.
LGTM.
And I think we should also update our issue templates.
Best,
Max Xu
On Tue, Aug 23, 2022 at 6:04 PM Yu <li...@apache.org> wrote:
> Hi team,
>
> Many thanks for your feedback! We've adjusted the convention based on your
> suggestions!
>
> Below is a brief summary of what we have reached a consensus on:
>
> ~~~~~~~~~~~~~~~~
>
> 1. Convention
>
> Continue to follow our existing convention (it's customized on Agular) [1]
>
> ~~~~~~~~~~~~~~~~
>
> 2. Definition
>
> [type] must be one of the following:
> - feat (abbr for "feature")
> - improve
> - fix
> - cleanup
> - refactor
> - revert
>
> [scope] must be one of the following:
> - admin
> - broker
> - cli (changes to CLI tools)
> - io
> - fn (abbr for "function")
> - meta (abbr for "metadata")
> - monitor
> - proxy
> - schema
> - sec (abbr for "security")
> - sql
> - storage
> - offload (changes to tiered storage)
> - txn
> - java
> - cpp
> - py
> - ws (changes to WebSocket)
> - test (changes to code tests)
> - ci (changes to CI workflow)
> - build (changes to dependencies, docker, build or release script)
> - misc
> - doc
> - blog
> - site
>
> For full details, see [Guide] Pulsar Pull Request Naming Convention [2]
>
> ~~~~~~~~~~~~~~~~
>
> If you have any concerns, feel free to comment before 13:00 August 25 (UTC
> +8).
>
> We'll start implementing it if there is no objection after that time.
>
> Thank you!
>
> ~~~~~~~~~~~~~~~~
>
> [1] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> [2]
>
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
>
> Yu and mangoGoForward
>
> On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
>
> > Hi Jiuming, Yunze, tison,
> > Thanks for your vote!
> >
> > ~~~~~~~~~~~~~~~~
> >
> > Hi tison,
> >
> > > "packaging logics"
> > > For example, build the docker image, build & publish shell scripts.
> >
> > If you refer to these changes, they belong to [build] scope.
> >
> > Yu and Zixuan
> >
> > On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com> wrote:
> >
> >> Hi Yu,
> >>
> >> Reply inline:
> >>
> >> > Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
> >> > We're considering to rename it to [cli] since:
> >>
> >> Make sense.
> >>
> >> > "deployment logic" If so, can we ignore this?
> >>
> >> I saw you already remove [deploy] scope. No comment here. It should be
> >> fine.
> >>
> >> > "packaging logics"
> >>
> >> For example, build the docker image, build & publish shell scripts.
> >>
> >> > How about defining [build] refer to the following?
> >>
> >> Make sense.
> >>
> >> > Two quick questions need your vote!
> >>
> >> To save letters, B & A.
> >>
> >> Best,
> >> tison.
> >>
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Hi team,
Many thanks for your feedback! We've adjusted the convention based on your
suggestions!
Below is a brief summary of what we have reached a consensus on:
~~~~~~~~~~~~~~~~
1. Convention
Continue to follow our existing convention (it's customized on Agular) [1]
~~~~~~~~~~~~~~~~
2. Definition
[type] must be one of the following:
- feat (abbr for "feature")
- improve
- fix
- cleanup
- refactor
- revert
[scope] must be one of the following:
- admin
- broker
- cli (changes to CLI tools)
- io
- fn (abbr for "function")
- meta (abbr for "metadata")
- monitor
- proxy
- schema
- sec (abbr for "security")
- sql
- storage
- offload (changes to tiered storage)
- txn
- java
- cpp
- py
- ws (changes to WebSocket)
- test (changes to code tests)
- ci (changes to CI workflow)
- build (changes to dependencies, docker, build or release script)
- misc
- doc
- blog
- site
For full details, see [Guide] Pulsar Pull Request Naming Convention [2]
~~~~~~~~~~~~~~~~
If you have any concerns, feel free to comment before 13:00 August 25 (UTC
+8).
We'll start implementing it if there is no objection after that time.
Thank you!
~~~~~~~~~~~~~~~~
[1] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
[2]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
Yu and mangoGoForward
On Tue, Aug 23, 2022 at 5:59 PM Yu <li...@apache.org> wrote:
> Hi Jiuming, Yunze, tison,
> Thanks for your vote!
>
> ~~~~~~~~~~~~~~~~
>
> Hi tison,
>
> > "packaging logics"
> > For example, build the docker image, build & publish shell scripts.
>
> If you refer to these changes, they belong to [build] scope.
>
> Yu and Zixuan
>
> On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com> wrote:
>
>> Hi Yu,
>>
>> Reply inline:
>>
>> > Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
>> > We're considering to rename it to [cli] since:
>>
>> Make sense.
>>
>> > "deployment logic" If so, can we ignore this?
>>
>> I saw you already remove [deploy] scope. No comment here. It should be
>> fine.
>>
>> > "packaging logics"
>>
>> For example, build the docker image, build & publish shell scripts.
>>
>> > How about defining [build] refer to the following?
>>
>> Make sense.
>>
>> > Two quick questions need your vote!
>>
>> To save letters, B & A.
>>
>> Best,
>> tison.
>>
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Hi Jiuming, Yunze, tison,
Thanks for your vote!
~~~~~~~~~~~~~~~~
Hi tison,
> "packaging logics"
> For example, build the docker image, build & publish shell scripts.
If you refer to these changes, they belong to [build] scope.
Yu and Zixuan
On Tue, Aug 23, 2022 at 1:25 PM tison <wa...@gmail.com> wrote:
> Hi Yu,
>
> Reply inline:
>
> > Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
> > We're considering to rename it to [cli] since:
>
> Make sense.
>
> > "deployment logic" If so, can we ignore this?
>
> I saw you already remove [deploy] scope. No comment here. It should be
> fine.
>
> > "packaging logics"
>
> For example, build the docker image, build & publish shell scripts.
>
> > How about defining [build] refer to the following?
>
> Make sense.
>
> > Two quick questions need your vote!
>
> To save letters, B & A.
>
> Best,
> tison.
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
Hi Yu,
Reply inline:
> Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
> We're considering to rename it to [cli] since:
Make sense.
> "deployment logic" If so, can we ignore this?
I saw you already remove [deploy] scope. No comment here. It should be fine.
> "packaging logics"
For example, build the docker image, build & publish shell scripts.
> How about defining [build] refer to the following?
Make sense.
> Two quick questions need your vote!
To save letters, B & A.
Best,
tison.
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yunze Xu <yz...@streamnative.io.INVALID>.
A, A
Thanks,
Yunze
> 2022年8月22日 12:47，Yu <li...@apache.org> 写道：
>
> Hi developers,
>
> Two quick questions need your vote!
>
> Which do you prefer?
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 1. Use "branch" or "BP"?
>
> Choice A: [fix][broker][branch-2.9] xxx
> Choice B: [fix][broker][BP-2.9] xxx
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 2. for the [scope], use "misc" or "chore"? [1]
>
> Choice A: misc
> Choice B: chore
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Thank you all!
>
> [1]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.58q1qxhu7pio
>
> Yu
>
> On Mon, Aug 22, 2022 at 12:44 PM Yu <li...@apache.org> wrote:
>
>> Hi tison,
>>
>> Thanks for your suggestions! We have several questions on [build]:
>>
>>> build - all things related to the build system, including tools,
>> deployment logic, maven changes, packaging logics, docker image, build
>> scripts.
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 1. "tools"
>>
>> What do you refer to? Plugins?
>>
>> Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
>> We're considering to rename it to [cli] since:
>> a. "cli" is more clear and short
>> b. Save the word "tool" for future use
>>
>> Does it make sense?
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 2. "deployment logic"
>>
>> Seems that it's an obsolete module and has not been updated for a long
>> while.
>> If so, can we ignore this?
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 3. Does "packaging logics" belong to [admin]? [2]
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 4. How about defining [build] refer to the following?
>>
>> - Dependency (Maven)
>>
>> In this way, we do not have the scope [dependency] since the changes to
>> dependency belong to [build].
>>
>> - Docker
>>
>> - Build or release script
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> Thank you for your reply!
>>
>> [1]
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.khz275ok35u5
>> [2]
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
>>
>> Yu and Zixuan
>>
>> On Mon, Aug 22, 2022 at 12:40 PM Yu <li...@apache.org> wrote:
>>
>>> Thank you tison and Zixuan!
>>>
>>> Agree on the following aspects:
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> # 1. Remove 3 [scope]s
>>>
>>> - Remove [workflow] since it can be replaced with other scopes
>>> eg.
>>> "[feat][workflow] Add instructions for previewing website changes"
>>> can be written as
>>> "[feat][doc] Add instructions for previewing website changes"
>>>
>>> - Remove [depoly] since changes to deployment can be represented by other
>>> [scope]s.
>>>
>>> - Remove [pkg]since it refers to package API [1], which belongs to
>>> [admin].
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> # 2. Update 4 [scope]s
>>>
>>> - Add [meta], which refers to changes to metadata.
>>>
>>> - Add [storage], which refers to changes to managed ledger.
>>>
>>> - Rename [ts] to [offloaded], which refers to changes to tiered storage.
>>>
>>> - Rename [func] to [fn], which refers to changes to function.
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> # 3. Remain the same
>>>
>>> These formats are fine to go:
>>>
>>> - Submit breaking changes
>>> [feat][broker]! Support xx
>>>
>>> - Submit PIP changes
>>> [feat][broker] PIP-198: Support xx
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> Feel free to comment, thank you!
>>>
>>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>
>>> [1] https://pulsar.apache.org/docs/next/admin-api-packages
>>>
>>> Yu and Zixuan
>>>
>>> On Fri, Aug 19, 2022 at 6:21 PM Zixuan Liu <no...@gmail.com> wrote:
>>>
>>>> +1 for fcn -> fn
>>>> +1 for ts -> offloader
>>>>
>>>> +1 * ci - CI workflow changes or debugging.
>>>> +1 * build - all things related to the build system, including tools,
>>>> deployment logic, maven changes, packaging logics, docker image,
>>>> buildscripts.
>>>>
>>>> `pkg` should belong to the `admin` scope, so suggest using the `admin`
>>>> instead `pkg`.
>>>>
>>>> `tool` is pulsar-admin, pulsar, pulsar-client, and so on cli, so keep
>>>> using
>>>> the `tool`.
>>>>
>>>> deploy should belong to the `build` scope`, so suggest using the `build`
>>>> instead `deploy`.
>>>>
>>>>
>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:46写道：
>>>>
>>>>> BTW, how can I sort changes for the metadata store?
>>>>>
>>>>> Best,
>>>>> tison.
>>>>>
>>>>>
>>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:44写道：
>>>>>
>>>>>> To proposal a workable solution, I suggest:
>>>>>>
>>>>>> replace
>>>>>>
>>>>>> * pkg
>>>>>> * tool
>>>>>> * deploy
>>>>>> * ci
>>>>>> * workflow
>>>>>> * build
>>>>>>
>>>>>> with
>>>>>>
>>>>>> * ci - CI workflow changes or debugging.
>>>>>> * build - all things related to the build system, including tools,
>>>>>> deployment logic, maven changes, packaging logics, docker image,
>>>> build
>>>>>> scripts.
>>>>>>
>>>>>> Best,
>>>>>> tison.
>>>>>>
>>>>>>
>>>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
>>>>>>
>>>>>>>> I intended to mean changes to "process / standard / guide" [2]
>>>> rather
>>>>>>> than "CI workflow", but it still causes confusion.
>>>>>>>
>>>>>>> How can a PR be relevant to these things? I think the result should
>>>> be
>>>>>>> either CI workflow changes or document updates. We don't need a
>>>>> dedicated
>>>>>>> "workflow" in such situations.
>>>>>>>
>>>>>>>> build system or external dependencies.
>>>>>>>
>>>>>>> So, it overlaps with deps. While I can regard it as
>>>> Maven/Docker/Build
>>>>>>> script related changes, we may not have "pkg", "tool", "deploy"
>>>> that can
>>>>>>> overlap with this.
>>>>>>>
>>>>>>> Best,
>>>>>>> tison.
>>>>>>>
>>>>>>>
>>>>>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
>>>>>>>
>>>>>>>> As for the type candidates:
>>>>>>>>
>>>>>>>> LGTM. No comment here.
>>>>>>>>
>>>>>>>> As for the scope candidates:
>>>>>>>>
>>>>>>>> +1 for dep -> deps
>>>>>>>> +1 for fcn -> fn
>>>>>>>> Among most communities and language conventions, the abbr of
>>>> function
>>>>>>>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd
>>>> prefer
>>>>> the
>>>>>>>> short one, fn.
>>>>>>>> +1 for ts -> offloader
>>>>>>>> If I get it right, tiered storage is offloader. We can save one
>>>> word
>>>>>>>> while keeping semantic.
>>>>>>>>
>>>>>>>> I don't know clearly what is:
>>>>>>>> * pkg
>>>>>>>> * tool
>>>>>>>> * deploy
>>>>>>>> * ci
>>>>>>>> * workflow
>>>>>>>> * build
>>>>>>>> They look quite similar or overlapping.
>>>>>>>>
>>>>>>>> Rest LGTM.
>>>>>>>>
>>>>>>>> As for the remaining issues:
>>>>>>>>
>>>>>>>> - Submit breaking changes
>>>>>>>> [feat][broker]! Support xx
>>>>>>>>
>>>>>>>> This is fine. Since we don't verify what follows the [type][scope]
>>>>>>>> section, it doesn't block the proposal.
>>>>>>>>
>>>>>>>> - Submit PIP changes
>>>>>>>> [feat][broker] PIP-198: Support xx
>>>>>>>>
>>>>>>>> The same as before. Contributors can name whatever they like. We
>>>> don't
>>>>>>>> set too complex rules.
>>>>>>>>
>>>>>>>> - Cherry pick changes [4]
>>>>>>>> Choice A: [fix][broker][branch-2.9] xxx
>>>>>>>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to
>>>> branch-2.9" in
>>>>>>>> the
>>>>>>>> PR description.
>>>>>>>>
>>>>>>>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how
>>>> the
>>>>>>>> Flink community does. BP means backport. But yes, it's not a
>>>>> requirement
>>>>>>>> but a suggestion.
>>>>>>>>
>>>>>>>>
>>>>>>>> Best,
>>>>>>>> tison.
>>>>>>>>
>>>>>>>
>>>>>
>>>>
>>>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Hi developers,
Two quick questions need your vote!
Which do you prefer?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 1. Use "branch" or "BP"?
Choice A: [fix][broker][branch-2.9] xxx
Choice B: [fix][broker][BP-2.9] xxx
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 2. for the [scope], use "misc" or "chore"? [1]
Choice A: misc
Choice B: chore
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Thank you all!
[1]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.58q1qxhu7pio
Yu
On Mon, Aug 22, 2022 at 12:44 PM Yu <li...@apache.org> wrote:
> Hi tison,
>
> Thanks for your suggestions! We have several questions on [build]:
>
> > build - all things related to the build system, including tools,
> deployment logic, maven changes, packaging logics, docker image, build
> scripts.
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 1. "tools"
>
> What do you refer to? Plugins?
>
> Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
> We're considering to rename it to [cli] since:
> a. "cli" is more clear and short
> b. Save the word "tool" for future use
>
> Does it make sense?
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 2. "deployment logic"
>
> Seems that it's an obsolete module and has not been updated for a long
> while.
> If so, can we ignore this?
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 3. Does "packaging logics" belong to [admin]? [2]
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 4. How about defining [build] refer to the following?
>
> - Dependency (Maven)
>
> In this way, we do not have the scope [dependency] since the changes to
> dependency belong to [build].
>
> - Docker
>
> - Build or release script
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Thank you for your reply!
>
> [1]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.khz275ok35u5
> [2]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
>
> Yu and Zixuan
>
> On Mon, Aug 22, 2022 at 12:40 PM Yu <li...@apache.org> wrote:
>
>> Thank you tison and Zixuan!
>>
>> Agree on the following aspects:
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 1. Remove 3 [scope]s
>>
>> - Remove [workflow] since it can be replaced with other scopes
>> eg.
>> "[feat][workflow] Add instructions for previewing website changes"
>> can be written as
>> "[feat][doc] Add instructions for previewing website changes"
>>
>> - Remove [depoly] since changes to deployment can be represented by other
>> [scope]s.
>>
>> - Remove [pkg]since it refers to package API [1], which belongs to
>> [admin].
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 2. Update 4 [scope]s
>>
>> - Add [meta], which refers to changes to metadata.
>>
>> - Add [storage], which refers to changes to managed ledger.
>>
>> - Rename [ts] to [offloaded], which refers to changes to tiered storage.
>>
>> - Rename [func] to [fn], which refers to changes to function.
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> # 3. Remain the same
>>
>> These formats are fine to go:
>>
>> - Submit breaking changes
>> [feat][broker]! Support xx
>>
>> - Submit PIP changes
>> [feat][broker] PIP-198: Support xx
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> Feel free to comment, thank you!
>>
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> [1] https://pulsar.apache.org/docs/next/admin-api-packages
>>
>> Yu and Zixuan
>>
>> On Fri, Aug 19, 2022 at 6:21 PM Zixuan Liu <no...@gmail.com> wrote:
>>
>>> +1 for fcn -> fn
>>> +1 for ts -> offloader
>>>
>>> +1 * ci - CI workflow changes or debugging.
>>> +1 * build - all things related to the build system, including tools,
>>> deployment logic, maven changes, packaging logics, docker image,
>>> buildscripts.
>>>
>>> `pkg` should belong to the `admin` scope, so suggest using the `admin`
>>> instead `pkg`.
>>>
>>> `tool` is pulsar-admin, pulsar, pulsar-client, and so on cli, so keep
>>> using
>>> the `tool`.
>>>
>>> deploy should belong to the `build` scope`, so suggest using the `build`
>>> instead `deploy`.
>>>
>>>
>>> tison <wa...@gmail.com> 于2022年8月19日周五 17:46写道：
>>>
>>> > BTW, how can I sort changes for the metadata store?
>>> >
>>> > Best,
>>> > tison.
>>> >
>>> >
>>> > tison <wa...@gmail.com> 于2022年8月19日周五 17:44写道：
>>> >
>>> > > To proposal a workable solution, I suggest:
>>> > >
>>> > > replace
>>> > >
>>> > > * pkg
>>> > > * tool
>>> > > * deploy
>>> > > * ci
>>> > > * workflow
>>> > > * build
>>> > >
>>> > > with
>>> > >
>>> > > * ci - CI workflow changes or debugging.
>>> > > * build - all things related to the build system, including tools,
>>> > > deployment logic, maven changes, packaging logics, docker image,
>>> build
>>> > > scripts.
>>> > >
>>> > > Best,
>>> > > tison.
>>> > >
>>> > >
>>> > > tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
>>> > >
>>> > >> > I intended to mean changes to "process / standard / guide" [2]
>>> rather
>>> > >> than "CI workflow", but it still causes confusion.
>>> > >>
>>> > >> How can a PR be relevant to these things? I think the result should
>>> be
>>> > >> either CI workflow changes or document updates. We don't need a
>>> > dedicated
>>> > >> "workflow" in such situations.
>>> > >>
>>> > >> > build system or external dependencies.
>>> > >>
>>> > >> So, it overlaps with deps. While I can regard it as
>>> Maven/Docker/Build
>>> > >> script related changes, we may not have "pkg", "tool", "deploy"
>>> that can
>>> > >> overlap with this.
>>> > >>
>>> > >> Best,
>>> > >> tison.
>>> > >>
>>> > >>
>>> > >> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
>>> > >>
>>> > >>> As for the type candidates:
>>> > >>>
>>> > >>> LGTM. No comment here.
>>> > >>>
>>> > >>> As for the scope candidates:
>>> > >>>
>>> > >>> +1 for dep -> deps
>>> > >>> +1 for fcn -> fn
>>> > >>> Among most communities and language conventions, the abbr of
>>> function
>>> > >>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd
>>> prefer
>>> > the
>>> > >>> short one, fn.
>>> > >>> +1 for ts -> offloader
>>> > >>> If I get it right, tiered storage is offloader. We can save one
>>> word
>>> > >>> while keeping semantic.
>>> > >>>
>>> > >>> I don't know clearly what is:
>>> > >>> * pkg
>>> > >>> * tool
>>> > >>> * deploy
>>> > >>> * ci
>>> > >>> * workflow
>>> > >>> * build
>>> > >>> They look quite similar or overlapping.
>>> > >>>
>>> > >>> Rest LGTM.
>>> > >>>
>>> > >>> As for the remaining issues:
>>> > >>>
>>> > >>> - Submit breaking changes
>>> > >>> [feat][broker]! Support xx
>>> > >>>
>>> > >>> This is fine. Since we don't verify what follows the [type][scope]
>>> > >>> section, it doesn't block the proposal.
>>> > >>>
>>> > >>> - Submit PIP changes
>>> > >>> [feat][broker] PIP-198: Support xx
>>> > >>>
>>> > >>> The same as before. Contributors can name whatever they like. We
>>> don't
>>> > >>> set too complex rules.
>>> > >>>
>>> > >>> - Cherry pick changes [4]
>>> > >>> Choice A: [fix][broker][branch-2.9] xxx
>>> > >>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to
>>> branch-2.9" in
>>> > >>> the
>>> > >>> PR description.
>>> > >>>
>>> > >>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how
>>> the
>>> > >>> Flink community does. BP means backport. But yes, it's not a
>>> > requirement
>>> > >>> but a suggestion.
>>> > >>>
>>> > >>>
>>> > >>> Best,
>>> > >>> tison.
>>> > >>>
>>> > >>
>>> >
>>>
>>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Hi tison,
Thanks for your suggestions! We have several questions on [build]:
> build - all things related to the build system, including tools,
deployment logic, maven changes, packaging logics, docker image, build
scripts.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 1. "tools"
What do you refer to? Plugins?
Besides, the existing scope, [tool], refers to Pulsar CLI tools [1].
We're considering to rename it to [cli] since:
a. "cli" is more clear and short
b. Save the word "tool" for future use
Does it make sense?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 2. "deployment logic"
Seems that it's an obsolete module and has not been updated for a long
while.
If so, can we ignore this?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 3. Does "packaging logics" belong to [admin]? [2]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 4. How about defining [build] refer to the following?
- Dependency (Maven)
In this way, we do not have the scope [dependency] since the changes to
dependency belong to [build].
- Docker
- Build or release script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Thank you for your reply!
[1]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.khz275ok35u5
[2]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
Yu and Zixuan
On Mon, Aug 22, 2022 at 12:40 PM Yu <li...@apache.org> wrote:
> Thank you tison and Zixuan!
>
> Agree on the following aspects:
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 1. Remove 3 [scope]s
>
> - Remove [workflow] since it can be replaced with other scopes
> eg.
> "[feat][workflow] Add instructions for previewing website changes"
> can be written as
> "[feat][doc] Add instructions for previewing website changes"
>
> - Remove [depoly] since changes to deployment can be represented by other
> [scope]s.
>
> - Remove [pkg]since it refers to package API [1], which belongs to [admin].
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 2. Update 4 [scope]s
>
> - Add [meta], which refers to changes to metadata.
>
> - Add [storage], which refers to changes to managed ledger.
>
> - Rename [ts] to [offloaded], which refers to changes to tiered storage.
>
> - Rename [func] to [fn], which refers to changes to function.
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> # 3. Remain the same
>
> These formats are fine to go:
>
> - Submit breaking changes
> [feat][broker]! Support xx
>
> - Submit PIP changes
> [feat][broker] PIP-198: Support xx
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Feel free to comment, thank you!
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> [1] https://pulsar.apache.org/docs/next/admin-api-packages
>
> Yu and Zixuan
>
> On Fri, Aug 19, 2022 at 6:21 PM Zixuan Liu <no...@gmail.com> wrote:
>
>> +1 for fcn -> fn
>> +1 for ts -> offloader
>>
>> +1 * ci - CI workflow changes or debugging.
>> +1 * build - all things related to the build system, including tools,
>> deployment logic, maven changes, packaging logics, docker image,
>> buildscripts.
>>
>> `pkg` should belong to the `admin` scope, so suggest using the `admin`
>> instead `pkg`.
>>
>> `tool` is pulsar-admin, pulsar, pulsar-client, and so on cli, so keep
>> using
>> the `tool`.
>>
>> deploy should belong to the `build` scope`, so suggest using the `build`
>> instead `deploy`.
>>
>>
>> tison <wa...@gmail.com> 于2022年8月19日周五 17:46写道：
>>
>> > BTW, how can I sort changes for the metadata store?
>> >
>> > Best,
>> > tison.
>> >
>> >
>> > tison <wa...@gmail.com> 于2022年8月19日周五 17:44写道：
>> >
>> > > To proposal a workable solution, I suggest:
>> > >
>> > > replace
>> > >
>> > > * pkg
>> > > * tool
>> > > * deploy
>> > > * ci
>> > > * workflow
>> > > * build
>> > >
>> > > with
>> > >
>> > > * ci - CI workflow changes or debugging.
>> > > * build - all things related to the build system, including tools,
>> > > deployment logic, maven changes, packaging logics, docker image, build
>> > > scripts.
>> > >
>> > > Best,
>> > > tison.
>> > >
>> > >
>> > > tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
>> > >
>> > >> > I intended to mean changes to "process / standard / guide" [2]
>> rather
>> > >> than "CI workflow", but it still causes confusion.
>> > >>
>> > >> How can a PR be relevant to these things? I think the result should
>> be
>> > >> either CI workflow changes or document updates. We don't need a
>> > dedicated
>> > >> "workflow" in such situations.
>> > >>
>> > >> > build system or external dependencies.
>> > >>
>> > >> So, it overlaps with deps. While I can regard it as
>> Maven/Docker/Build
>> > >> script related changes, we may not have "pkg", "tool", "deploy" that
>> can
>> > >> overlap with this.
>> > >>
>> > >> Best,
>> > >> tison.
>> > >>
>> > >>
>> > >> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
>> > >>
>> > >>> As for the type candidates:
>> > >>>
>> > >>> LGTM. No comment here.
>> > >>>
>> > >>> As for the scope candidates:
>> > >>>
>> > >>> +1 for dep -> deps
>> > >>> +1 for fcn -> fn
>> > >>> Among most communities and language conventions, the abbr of
>> function
>> > >>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd
>> prefer
>> > the
>> > >>> short one, fn.
>> > >>> +1 for ts -> offloader
>> > >>> If I get it right, tiered storage is offloader. We can save one
>> word
>> > >>> while keeping semantic.
>> > >>>
>> > >>> I don't know clearly what is:
>> > >>> * pkg
>> > >>> * tool
>> > >>> * deploy
>> > >>> * ci
>> > >>> * workflow
>> > >>> * build
>> > >>> They look quite similar or overlapping.
>> > >>>
>> > >>> Rest LGTM.
>> > >>>
>> > >>> As for the remaining issues:
>> > >>>
>> > >>> - Submit breaking changes
>> > >>> [feat][broker]! Support xx
>> > >>>
>> > >>> This is fine. Since we don't verify what follows the [type][scope]
>> > >>> section, it doesn't block the proposal.
>> > >>>
>> > >>> - Submit PIP changes
>> > >>> [feat][broker] PIP-198: Support xx
>> > >>>
>> > >>> The same as before. Contributors can name whatever they like. We
>> don't
>> > >>> set too complex rules.
>> > >>>
>> > >>> - Cherry pick changes [4]
>> > >>> Choice A: [fix][broker][branch-2.9] xxx
>> > >>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to
>> branch-2.9" in
>> > >>> the
>> > >>> PR description.
>> > >>>
>> > >>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how
>> the
>> > >>> Flink community does. BP means backport. But yes, it's not a
>> > requirement
>> > >>> but a suggestion.
>> > >>>
>> > >>>
>> > >>> Best,
>> > >>> tison.
>> > >>>
>> > >>
>> >
>>
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Thank you tison and Zixuan!
Agree on the following aspects:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 1. Remove 3 [scope]s
- Remove [workflow] since it can be replaced with other scopes
eg.
"[feat][workflow] Add instructions for previewing website changes"
can be written as
"[feat][doc] Add instructions for previewing website changes"
- Remove [depoly] since changes to deployment can be represented by other
[scope]s.
- Remove [pkg]since it refers to package API [1], which belongs to [admin].
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 2. Update 4 [scope]s
- Add [meta], which refers to changes to metadata.
- Add [storage], which refers to changes to managed ledger.
- Rename [ts] to [offloaded], which refers to changes to tiered storage.
- Rename [func] to [fn], which refers to changes to function.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# 3. Remain the same
These formats are fine to go:
- Submit breaking changes
[feat][broker]! Support xx
- Submit PIP changes
[feat][broker] PIP-198: Support xx
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Feel free to comment, thank you!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[1] https://pulsar.apache.org/docs/next/admin-api-packages
Yu and Zixuan
On Fri, Aug 19, 2022 at 6:21 PM Zixuan Liu <no...@gmail.com> wrote:
> +1 for fcn -> fn
> +1 for ts -> offloader
>
> +1 * ci - CI workflow changes or debugging.
> +1 * build - all things related to the build system, including tools,
> deployment logic, maven changes, packaging logics, docker image,
> buildscripts.
>
> `pkg` should belong to the `admin` scope, so suggest using the `admin`
> instead `pkg`.
>
> `tool` is pulsar-admin, pulsar, pulsar-client, and so on cli, so keep using
> the `tool`.
>
> deploy should belong to the `build` scope`, so suggest using the `build`
> instead `deploy`.
>
>
> tison <wa...@gmail.com> 于2022年8月19日周五 17:46写道：
>
> > BTW, how can I sort changes for the metadata store?
> >
> > Best,
> > tison.
> >
> >
> > tison <wa...@gmail.com> 于2022年8月19日周五 17:44写道：
> >
> > > To proposal a workable solution, I suggest:
> > >
> > > replace
> > >
> > > * pkg
> > > * tool
> > > * deploy
> > > * ci
> > > * workflow
> > > * build
> > >
> > > with
> > >
> > > * ci - CI workflow changes or debugging.
> > > * build - all things related to the build system, including tools,
> > > deployment logic, maven changes, packaging logics, docker image, build
> > > scripts.
> > >
> > > Best,
> > > tison.
> > >
> > >
> > > tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
> > >
> > >> > I intended to mean changes to "process / standard / guide" [2]
> rather
> > >> than "CI workflow", but it still causes confusion.
> > >>
> > >> How can a PR be relevant to these things? I think the result should be
> > >> either CI workflow changes or document updates. We don't need a
> > dedicated
> > >> "workflow" in such situations.
> > >>
> > >> > build system or external dependencies.
> > >>
> > >> So, it overlaps with deps. While I can regard it as Maven/Docker/Build
> > >> script related changes, we may not have "pkg", "tool", "deploy" that
> can
> > >> overlap with this.
> > >>
> > >> Best,
> > >> tison.
> > >>
> > >>
> > >> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
> > >>
> > >>> As for the type candidates:
> > >>>
> > >>> LGTM. No comment here.
> > >>>
> > >>> As for the scope candidates:
> > >>>
> > >>> +1 for dep -> deps
> > >>> +1 for fcn -> fn
> > >>> Among most communities and language conventions, the abbr of
> function
> > >>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd prefer
> > the
> > >>> short one, fn.
> > >>> +1 for ts -> offloader
> > >>> If I get it right, tiered storage is offloader. We can save one
> word
> > >>> while keeping semantic.
> > >>>
> > >>> I don't know clearly what is:
> > >>> * pkg
> > >>> * tool
> > >>> * deploy
> > >>> * ci
> > >>> * workflow
> > >>> * build
> > >>> They look quite similar or overlapping.
> > >>>
> > >>> Rest LGTM.
> > >>>
> > >>> As for the remaining issues:
> > >>>
> > >>> - Submit breaking changes
> > >>> [feat][broker]! Support xx
> > >>>
> > >>> This is fine. Since we don't verify what follows the [type][scope]
> > >>> section, it doesn't block the proposal.
> > >>>
> > >>> - Submit PIP changes
> > >>> [feat][broker] PIP-198: Support xx
> > >>>
> > >>> The same as before. Contributors can name whatever they like. We
> don't
> > >>> set too complex rules.
> > >>>
> > >>> - Cherry pick changes [4]
> > >>> Choice A: [fix][broker][branch-2.9] xxx
> > >>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9"
> in
> > >>> the
> > >>> PR description.
> > >>>
> > >>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how
> the
> > >>> Flink community does. BP means backport. But yes, it's not a
> > requirement
> > >>> but a suggestion.
> > >>>
> > >>>
> > >>> Best,
> > >>> tison.
> > >>>
> > >>
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Zixuan Liu <no...@gmail.com>.
+1 for fcn -> fn
+1 for ts -> offloader
+1 * ci - CI workflow changes or debugging.
+1 * build - all things related to the build system, including tools,
deployment logic, maven changes, packaging logics, docker image,
buildscripts.
`pkg` should belong to the `admin` scope, so suggest using the `admin`
instead `pkg`.
`tool` is pulsar-admin, pulsar, pulsar-client, and so on cli, so keep using
the `tool`.
deploy should belong to the `build` scope`, so suggest using the `build`
instead `deploy`.
tison <wa...@gmail.com> 于2022年8月19日周五 17:46写道：
> BTW, how can I sort changes for the metadata store?
>
> Best,
> tison.
>
>
> tison <wa...@gmail.com> 于2022年8月19日周五 17:44写道：
>
> > To proposal a workable solution, I suggest:
> >
> > replace
> >
> > * pkg
> > * tool
> > * deploy
> > * ci
> > * workflow
> > * build
> >
> > with
> >
> > * ci - CI workflow changes or debugging.
> > * build - all things related to the build system, including tools,
> > deployment logic, maven changes, packaging logics, docker image, build
> > scripts.
> >
> > Best,
> > tison.
> >
> >
> > tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
> >
> >> > I intended to mean changes to "process / standard / guide" [2] rather
> >> than "CI workflow", but it still causes confusion.
> >>
> >> How can a PR be relevant to these things? I think the result should be
> >> either CI workflow changes or document updates. We don't need a
> dedicated
> >> "workflow" in such situations.
> >>
> >> > build system or external dependencies.
> >>
> >> So, it overlaps with deps. While I can regard it as Maven/Docker/Build
> >> script related changes, we may not have "pkg", "tool", "deploy" that can
> >> overlap with this.
> >>
> >> Best,
> >> tison.
> >>
> >>
> >> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
> >>
> >>> As for the type candidates:
> >>>
> >>> LGTM. No comment here.
> >>>
> >>> As for the scope candidates:
> >>>
> >>> +1 for dep -> deps
> >>> +1 for fcn -> fn
> >>> Among most communities and language conventions, the abbr of function
> >>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd prefer
> the
> >>> short one, fn.
> >>> +1 for ts -> offloader
> >>> If I get it right, tiered storage is offloader. We can save one word
> >>> while keeping semantic.
> >>>
> >>> I don't know clearly what is:
> >>> * pkg
> >>> * tool
> >>> * deploy
> >>> * ci
> >>> * workflow
> >>> * build
> >>> They look quite similar or overlapping.
> >>>
> >>> Rest LGTM.
> >>>
> >>> As for the remaining issues:
> >>>
> >>> - Submit breaking changes
> >>> [feat][broker]! Support xx
> >>>
> >>> This is fine. Since we don't verify what follows the [type][scope]
> >>> section, it doesn't block the proposal.
> >>>
> >>> - Submit PIP changes
> >>> [feat][broker] PIP-198: Support xx
> >>>
> >>> The same as before. Contributors can name whatever they like. We don't
> >>> set too complex rules.
> >>>
> >>> - Cherry pick changes [4]
> >>> Choice A: [fix][broker][branch-2.9] xxx
> >>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> >>> the
> >>> PR description.
> >>>
> >>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how the
> >>> Flink community does. BP means backport. But yes, it's not a
> requirement
> >>> but a suggestion.
> >>>
> >>>
> >>> Best,
> >>> tison.
> >>>
> >>
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
BTW, how can I sort changes for the metadata store?
Best,
tison.
tison <wa...@gmail.com> 于2022年8月19日周五 17:44写道：
> To proposal a workable solution, I suggest:
>
> replace
>
> * pkg
> * tool
> * deploy
> * ci
> * workflow
> * build
>
> with
>
> * ci - CI workflow changes or debugging.
> * build - all things related to the build system, including tools,
> deployment logic, maven changes, packaging logics, docker image, build
> scripts.
>
> Best,
> tison.
>
>
> tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
>
>> > I intended to mean changes to "process / standard / guide" [2] rather
>> than "CI workflow", but it still causes confusion.
>>
>> How can a PR be relevant to these things? I think the result should be
>> either CI workflow changes or document updates. We don't need a dedicated
>> "workflow" in such situations.
>>
>> > build system or external dependencies.
>>
>> So, it overlaps with deps. While I can regard it as Maven/Docker/Build
>> script related changes, we may not have "pkg", "tool", "deploy" that can
>> overlap with this.
>>
>> Best,
>> tison.
>>
>>
>> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
>>
>>> As for the type candidates:
>>>
>>> LGTM. No comment here.
>>>
>>> As for the scope candidates:
>>>
>>> +1 for dep -> deps
>>> +1 for fcn -> fn
>>> Among most communities and language conventions, the abbr of function
>>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd prefer the
>>> short one, fn.
>>> +1 for ts -> offloader
>>> If I get it right, tiered storage is offloader. We can save one word
>>> while keeping semantic.
>>>
>>> I don't know clearly what is:
>>> * pkg
>>> * tool
>>> * deploy
>>> * ci
>>> * workflow
>>> * build
>>> They look quite similar or overlapping.
>>>
>>> Rest LGTM.
>>>
>>> As for the remaining issues:
>>>
>>> - Submit breaking changes
>>> [feat][broker]! Support xx
>>>
>>> This is fine. Since we don't verify what follows the [type][scope]
>>> section, it doesn't block the proposal.
>>>
>>> - Submit PIP changes
>>> [feat][broker] PIP-198: Support xx
>>>
>>> The same as before. Contributors can name whatever they like. We don't
>>> set too complex rules.
>>>
>>> - Cherry pick changes [4]
>>> Choice A: [fix][broker][branch-2.9] xxx
>>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
>>> the
>>> PR description.
>>>
>>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how the
>>> Flink community does. BP means backport. But yes, it's not a requirement
>>> but a suggestion.
>>>
>>>
>>> Best,
>>> tison.
>>>
>>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
To proposal a workable solution, I suggest:
replace
* pkg
* tool
* deploy
* ci
* workflow
* build
with
* ci - CI workflow changes or debugging.
* build - all things related to the build system, including tools,
deployment logic, maven changes, packaging logics, docker image, build
scripts.
Best,
tison.
tison <wa...@gmail.com> 于2022年8月19日周五 17:41写道：
> > I intended to mean changes to "process / standard / guide" [2] rather
> than "CI workflow", but it still causes confusion.
>
> How can a PR be relevant to these things? I think the result should be
> either CI workflow changes or document updates. We don't need a dedicated
> "workflow" in such situations.
>
> > build system or external dependencies.
>
> So, it overlaps with deps. While I can regard it as Maven/Docker/Build
> script related changes, we may not have "pkg", "tool", "deploy" that can
> overlap with this.
>
> Best,
> tison.
>
>
> tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
>
>> As for the type candidates:
>>
>> LGTM. No comment here.
>>
>> As for the scope candidates:
>>
>> +1 for dep -> deps
>> +1 for fcn -> fn
>> Among most communities and language conventions, the abbr of function
>> is fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd prefer the
>> short one, fn.
>> +1 for ts -> offloader
>> If I get it right, tiered storage is offloader. We can save one word
>> while keeping semantic.
>>
>> I don't know clearly what is:
>> * pkg
>> * tool
>> * deploy
>> * ci
>> * workflow
>> * build
>> They look quite similar or overlapping.
>>
>> Rest LGTM.
>>
>> As for the remaining issues:
>>
>> - Submit breaking changes
>> [feat][broker]! Support xx
>>
>> This is fine. Since we don't verify what follows the [type][scope]
>> section, it doesn't block the proposal.
>>
>> - Submit PIP changes
>> [feat][broker] PIP-198: Support xx
>>
>> The same as before. Contributors can name whatever they like. We don't
>> set too complex rules.
>>
>> - Cherry pick changes [4]
>> Choice A: [fix][broker][branch-2.9] xxx
>> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
>> the
>> PR description.
>>
>> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how the
>> Flink community does. BP means backport. But yes, it's not a requirement
>> but a suggestion.
>>
>>
>> Best,
>> tison.
>>
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
> I intended to mean changes to "process / standard / guide" [2] rather
than "CI workflow", but it still causes confusion.
How can a PR be relevant to these things? I think the result should be
either CI workflow changes or document updates. We don't need a dedicated
"workflow" in such situations.
> build system or external dependencies.
So, it overlaps with deps. While I can regard it as Maven/Docker/Build
script related changes, we may not have "pkg", "tool", "deploy" that can
overlap with this.
Best,
tison.
tison <wa...@gmail.com> 于2022年8月19日周五 17:38写道：
> As for the type candidates:
>
> LGTM. No comment here.
>
> As for the scope candidates:
>
> +1 for dep -> deps
> +1 for fcn -> fn
> Among most communities and language conventions, the abbr of function is
> fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd prefer the
> short one, fn.
> +1 for ts -> offloader
> If I get it right, tiered storage is offloader. We can save one word
> while keeping semantic.
>
> I don't know clearly what is:
> * pkg
> * tool
> * deploy
> * ci
> * workflow
> * build
> They look quite similar or overlapping.
>
> Rest LGTM.
>
> As for the remaining issues:
>
> - Submit breaking changes
> [feat][broker]! Support xx
>
> This is fine. Since we don't verify what follows the [type][scope]
> section, it doesn't block the proposal.
>
> - Submit PIP changes
> [feat][broker] PIP-198: Support xx
>
> The same as before. Contributors can name whatever they like. We don't set
> too complex rules.
>
> - Cherry pick changes [4]
> Choice A: [fix][broker][branch-2.9] xxx
> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in the
> PR description.
>
> I'd prefer [fix][broker][BP-2.9] to save some letters. This is how the
> Flink community does. BP means backport. But yes, it's not a requirement
> but a suggestion.
>
>
> Best,
> tison.
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
As for the type candidates:
LGTM. No comment here.
As for the scope candidates:
+1 for dep -> deps
+1 for fcn -> fn
Among most communities and language conventions, the abbr of function is
fn (Rust), fun (Erlang), or func (Golang). No fcn IIRC. I'd prefer the
short one, fn.
+1 for ts -> offloader
If I get it right, tiered storage is offloader. We can save one word
while keeping semantic.
I don't know clearly what is:
* pkg
* tool
* deploy
* ci
* workflow
* build
They look quite similar or overlapping.
Rest LGTM.
As for the remaining issues:
- Submit breaking changes
[feat][broker]! Support xx
This is fine. Since we don't verify what follows the [type][scope] section,
it doesn't block the proposal.
- Submit PIP changes
[feat][broker] PIP-198: Support xx
The same as before. Contributors can name whatever they like. We don't set
too complex rules.
- Cherry pick changes [4]
Choice A: [fix][broker][branch-2.9] xxx
Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in the
PR description.
I'd prefer [fix][broker][BP-2.9] to save some letters. This is how the
Flink community does. BP means backport. But yes, it's not a requirement
but a suggestion.
Best,
tison.
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Thanks, Zixuan!
> It should be the same thing. If I make a mistake, please tell me.
Sorry, I misunderstood it. I’ve removed the “rest” scope.
~~~~~~~~~~~~~~~~~~~~
As we discussed just now, we reached consensuses on the following aspects:
- Use “deps” to represent “dependency” since “dep” might be confused with
“deploy”.
- Use “sec” to represent “security”.
~~~~~~~~~~~~~~~~~~~~
But we still have an issue:
How to define storage / tiered storage (scope)?
- Option 1: only create “storage” scope.
It contains all changes to storage (bookie, tiered storage, etc).
- Option 2: create both “storage” and “tiered storage” scopes.
Bookie changes go to “storage”.
Tiered storage changes go to “tiesto” (abbr. "ts" is not used since it
might be confused with TypeScript).
Hi developers, which do you prefer? Or any other suggestions? Thank you!
Yu
On Fri, Aug 19, 2022 at 5:01 PM Yu <li...@apache.org> wrote:
> Thanks, tison!
>
> > What's the difference between ci, workflow, and build?
>
> As explained in [Guide] Pulsar Pull Request Naming Convention [1],
>
> - ci:
> CI configuration files and scripts.
>
> - build:
> build system or external dependencies.
>
> - workflow:
> I intended to mean changes to "process / standard / guide" [2] rather than
> "CI workflow", but it still causes confusion.
> So I'm wondering if the word "workflow" should be changed to "process"? Or
> another more appropriate one?
> Previously, I did not categorize "process / standard / guide" to "misc"
> because I thought they are important and should be highlighted.
> But maybe we have to categorize it to "misc" if can not find a suitable
> word.
> Thoughts?
>
> > I make a change on checkstyle rules, which one should I sort it to?
> From the definition above, this belongs to "build", does it make sense?
>
> ~~~~~~~~~~
>
> Hi anyone else, feel free to comment, thank you!
>
> ~~~~~~~~~~
>
> [1]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.skv7rjx6t1y0
>
> [2] Examples:
>
> - Update issue templates:
> [feat][workflow] Change doc issue template from markdown to yml,
> https://github.com/apache/pulsar/pull/13359
>
> - Update PR templates:
> [improve][workflow] Add PR guideline info to PR template,
> https://github.com/apache/pulsar/pull/15005
>
> - Add standards:
> [feature][workflow] Add Pulsar PR Naming Convention,
> https://github.com/apache/pulsar/pull/16055
>
> - Add guides:
> [feat][workflow] Add instructions for previewing website changes,
> https://github.com/apache/pulsar-site/pull/136
>
> ~~~~~~~~~~
>
> Yu
>
> On Thu, Aug 18, 2022 at 11:51 PM Zixuan Liu <no...@gmail.com> wrote:
>
>> > Since here uses a singular noun, how about using "dep"?
>>
>> Sometimes we will update multiple dependencies so I want to use the
>> `deps`.
>>
>> > Are "security" and "tiered-storage" too long?
>>
>> Although the word is very long, it will look very clear.
>>
>> > "rest" here refers to client library REST [2]
>> And the "rest" you mentioned belongs to "admin", which includes
>> pulsar-admin, REST API, Java admin API [3]
>>
>> It should be the same thing. If I make a mistake please tell me.
>>
>> Thanks,
>> Zixuan
>>
>>
>> Yu <li...@apache.org> 于2022年8月18日周四 16:45写道：
>>
>> > Thank you all!
>> >
>> > Hi Zixuan and all,
>> >
>> > > - dep (abbr for dependency) -> deps
>> > "dep" is abbr for "dependency"
>> > while "deps" can be abbr for "dependencies"
>> > Since here uses a singular noun, how about using "dep"?
>> >
>> > > - fcn (abbr for function) -> func
>> > +1
>> >
>> > > - sec (abbr for security) -> security
>> > > - ts (abbr for tiered storage) -> tiered-storage
>> > Are "security" and "tiered-storage" too long?
>> > - "sec" is commonly used in the science industry [1]
>> > - "ts" is suggested because you might know it refers to "tiered
>> storage" at
>> > first glance
>> > since there seems to be no similar Pulsar concept/terminology
>> > that uses the same abbreviation.
>> >
>> > - rest (changes to REST) -> Using the `admin` instead of rest?
>> > "rest" here refers to client library REST [2]
>> > And the "rest" you mentioned belongs to "admin", which includes
>> > pulsar-admin, REST API, Java admin API [3]
>> >
>> > - misc (abbr for miscellaneous) -> chore?
>> > I'm OK with both choices.
>> > Hi other developers, what's your preference on this?
>> >
>> > [1] https://www.abbreviations.com/abbreviation/Security
>> > [2] https://pulsar.apache.org/docs/next/client-libraries-rest
>> > [3]
>> >
>> >
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
>> >
>> >
>> > Yu
>> >
>> > On Thu, Aug 18, 2022 at 10:50 AM Zixuan Liu <no...@gmail.com> wrote:
>> >
>> > > Thank yu for your work! Overall looks good to me, but I would like to
>> > > request changes.
>> > >
>> > > I prefer:
>> > >
>> > > - dep (abbr for dependency) -> deps
>> > > - fcn (abbr for function) -> func
>> > > - sec (abbr for security) -> security
>> > > - ts (abbr for tiered storage) -> tiered-storage
>> > > - txn (abbr for transaction)
>> > > - rest (changes to REST) -> Using the `admin` instead of rest?
>> > > - misc (abbr for miscellaneous) -> chore?
>> > >
>> > >
>> > > > - Submit breaking changes
>> > > > [feat][broker]! Support xx
>> > >
>> > > There should be no such behavior. When we have the breaking changes we
>> > must
>> > > make a PIP.
>> > >
>> > > > - Submit PIP changes
>> > > > [feat][broker] PIP-198: Support xx
>> > >
>> > > Prefer [feat][broker][PIP-198] Support xx
>> > >
>> > >
>> > > > - Cherry pick changes [4]
>> > > > Choice A: [fix][broker][branch-2.9] xxx
>> > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
>> branch-2.9" in
>> > > the
>> > > > PR description.
>> > >
>> > > I prefer choice A.
>> > >
>> > > Thanks,
>> > > Zixuan
>> > >
>> > >
>> > > Zike Yang <zi...@apache.org> 于2022年8月18日周四 08:43写道：
>> > >
>> > > > LGTM.
>> > > >
>> > > > > - Cherry pick changes [4]
>> > > > > Choice A: [fix][broker][branch-2.9] xxx
>> > > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
>> branch-2.9"
>> > in
>> > > > the
>> > > > > PR description.
>> > > >
>> > > > I prefer A.
>> > > >
>> > > > Thanks,
>> > > > Zike Yang
>> > > > Zike Yang
>> > > >
>> > > > On Wed, Aug 17, 2022 at 7:41 PM Qiang Huang <
>> qiang.huang1991@gmail.com
>> > >
>> > > > wrote:
>> > > > >
>> > > > > Great work. I prefer "Choice A".
>> > > > > > Cherry pick changes [4]
>> > > > > > Choice A: [fix][broker][branch-2.9] xxx
>> > > > >
>> > > > > Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
>> > > > >
>> > > > > > LGTM.
>> > > > > >
>> > > > > > Thanks,
>> > > > > > Yunze
>> > > > > >
>> > > > > >
>> > > > > >
>> > > > > >
>> > > > > > > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
>> > > > > > >
>> > > > > > > Hi team,
>> > > > > > >
>> > > > > > > For PIP 198: Standardize PR Naming Convention using GitHub
>> > Actions
>> > > > [1]
>> > > > > > >
>> > > > > > > How to define [type] and [scope]? Do these abbreviations LGTY?
>> > > > > > >
>> > > > > > > *[Guide] Pulsar Pull Request Naming Convention* [2] contains
>> > > > everything
>> > > > > > > about the definition. Feel free to check and comment!
>> > > > > > >
>> > > > > > > ~~~~~~~~~~
>> > > > > > >
>> > > > > > > TL;DR
>> > > > > > >
>> > > > > > > PR title format: [type][scope] Summary [3]
>> > > > > > >
>> > > > > > > ~~~~~~~~~~
>> > > > > > >
>> > > > > > > [type]
>> > > > > > >
>> > > > > > > 1. Definition: what actions do you take?
>> > > > > > >
>> > > > > > > 2. It must be one of the following:
>> > > > > > > - feat (abbr for "feature")
>> > > > > > > - improve
>> > > > > > > - fix
>> > > > > > > - cleanup
>> > > > > > > - refactor
>> > > > > > > - revert
>> > > > > > >
>> > > > > > > ~~~~~~~~~~
>> > > > > > >
>> > > > > > > [scope]
>> > > > > > >
>> > > > > > > 1. Definition: where do you make changes?
>> > > > > > >
>> > > > > > > 2. It must be one of the following:
>> > > > > > > - admin (changes to pulsar-admin, REST API, Java admin API)
>> > > > > > > - broker
>> > > > > > > - io
>> > > > > > > - deploy
>> > > > > > > - dep (abbr for dependency)
>> > > > > > > - fcn (abbr for function)
>> > > > > > > - monitor
>> > > > > > > - pkg (abbr for package)
>> > > > > > > - proxy
>> > > > > > > - schema
>> > > > > > > - sec (abbr for security)
>> > > > > > > - sql
>> > > > > > > - ts (abbr for tiered storage)
>> > > > > > > - tool
>> > > > > > > - txn (abbr for transaction)
>> > > > > > >
>> > > > > > > - java (changes to Java client)
>> > > > > > > - cpp (changes to C++ client)
>> > > > > > > - py (changes to Python client)
>> > > > > > > - ws (changes to WebSocket)
>> > > > > > > - rest (changes to REST)
>> > > > > > >
>> > > > > > > - test
>> > > > > > > - ci
>> > > > > > > - workflow
>> > > > > > > - build
>> > > > > > > - misc (abbr for miscellaneous)
>> > > > > > >
>> > > > > > > - doc
>> > > > > > > - blog
>> > > > > > > - site (abbr for website)
>> > > > > > >
>> > > > > > > ~~~~~~~~~~
>> > > > > > >
>> > > > > > > Besides, many developers have different opinions on the
>> following
>> > > > > > aspects.
>> > > > > > > What's your writing preference?
>> > > > > > >
>> > > > > > > - Submit breaking changes
>> > > > > > > [feat][broker]! Support xx
>> > > > > > >
>> > > > > > > - Submit PIP changes
>> > > > > > > [feat][broker] PIP-198: Support xx
>> > > > > > >
>> > > > > > > - Cherry pick changes [4]
>> > > > > > > Choice A: [fix][broker][branch-2.9] xxx
>> > > > > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
>> > > branch-2.9"
>> > > > in
>> > > > > > the
>> > > > > > > PR description.
>> > > > > > >
>> > > > > > > ~~~~~~~~~~
>> > > > > > >
>> > > > > > > Feel free to comment and make your voice heard. Go vote! Thank
>> > you!
>> > > > > > >
>> > > > > > > [1]
>> > > > > > >
>> > > > > >
>> > > >
>> > >
>> >
>> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
>> > > > > > > [2]
>> > > https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
>> > > > > > > [3]
>> > > > > > >
>> > > > > >
>> > > >
>> > >
>> >
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
>> > > > > > > [4]
>> > > > > > >
>> > > > > >
>> > > >
>> > >
>> >
>> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
>> > > > > > >
>> > > > > > > Yu
>> > > > > >
>> > > > > >
>> > > > >
>> > > > > --
>> > > > > BR,
>> > > > > Qiang Huang
>> > > >
>> > >
>> >
>>
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Thanks, tison!
> What's the difference between ci, workflow, and build?
As explained in [Guide] Pulsar Pull Request Naming Convention [1],
- ci:
CI configuration files and scripts.
- build:
build system or external dependencies.
- workflow:
I intended to mean changes to "process / standard / guide" [2] rather than
"CI workflow", but it still causes confusion.
So I'm wondering if the word "workflow" should be changed to "process"? Or
another more appropriate one?
Previously, I did not categorize "process / standard / guide" to "misc"
because I thought they are important and should be highlighted.
But maybe we have to categorize it to "misc" if can not find a suitable
word.
Thoughts?
> I make a change on checkstyle rules, which one should I sort it to?
From the definition above, this belongs to "build", does it make sense?
~~~~~~~~~~
Hi anyone else, feel free to comment, thank you!
~~~~~~~~~~
[1]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.skv7rjx6t1y0
[2] Examples:
- Update issue templates:
[feat][workflow] Change doc issue template from markdown to yml,
https://github.com/apache/pulsar/pull/13359
- Update PR templates:
[improve][workflow] Add PR guideline info to PR template,
https://github.com/apache/pulsar/pull/15005
- Add standards:
[feature][workflow] Add Pulsar PR Naming Convention,
https://github.com/apache/pulsar/pull/16055
- Add guides:
[feat][workflow] Add instructions for previewing website changes,
https://github.com/apache/pulsar-site/pull/136
~~~~~~~~~~
Yu
On Thu, Aug 18, 2022 at 11:51 PM Zixuan Liu <no...@gmail.com> wrote:
> > Since here uses a singular noun, how about using "dep"?
>
> Sometimes we will update multiple dependencies so I want to use the `deps`.
>
> > Are "security" and "tiered-storage" too long?
>
> Although the word is very long, it will look very clear.
>
> > "rest" here refers to client library REST [2]
> And the "rest" you mentioned belongs to "admin", which includes
> pulsar-admin, REST API, Java admin API [3]
>
> It should be the same thing. If I make a mistake please tell me.
>
> Thanks,
> Zixuan
>
>
> Yu <li...@apache.org> 于2022年8月18日周四 16:45写道：
>
> > Thank you all!
> >
> > Hi Zixuan and all,
> >
> > > - dep (abbr for dependency) -> deps
> > "dep" is abbr for "dependency"
> > while "deps" can be abbr for "dependencies"
> > Since here uses a singular noun, how about using "dep"?
> >
> > > - fcn (abbr for function) -> func
> > +1
> >
> > > - sec (abbr for security) -> security
> > > - ts (abbr for tiered storage) -> tiered-storage
> > Are "security" and "tiered-storage" too long?
> > - "sec" is commonly used in the science industry [1]
> > - "ts" is suggested because you might know it refers to "tiered storage"
> at
> > first glance
> > since there seems to be no similar Pulsar concept/terminology
> > that uses the same abbreviation.
> >
> > - rest (changes to REST) -> Using the `admin` instead of rest?
> > "rest" here refers to client library REST [2]
> > And the "rest" you mentioned belongs to "admin", which includes
> > pulsar-admin, REST API, Java admin API [3]
> >
> > - misc (abbr for miscellaneous) -> chore?
> > I'm OK with both choices.
> > Hi other developers, what's your preference on this?
> >
> > [1] https://www.abbreviations.com/abbreviation/Security
> > [2] https://pulsar.apache.org/docs/next/client-libraries-rest
> > [3]
> >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
> >
> >
> > Yu
> >
> > On Thu, Aug 18, 2022 at 10:50 AM Zixuan Liu <no...@gmail.com> wrote:
> >
> > > Thank yu for your work! Overall looks good to me, but I would like to
> > > request changes.
> > >
> > > I prefer:
> > >
> > > - dep (abbr for dependency) -> deps
> > > - fcn (abbr for function) -> func
> > > - sec (abbr for security) -> security
> > > - ts (abbr for tiered storage) -> tiered-storage
> > > - txn (abbr for transaction)
> > > - rest (changes to REST) -> Using the `admin` instead of rest?
> > > - misc (abbr for miscellaneous) -> chore?
> > >
> > >
> > > > - Submit breaking changes
> > > > [feat][broker]! Support xx
> > >
> > > There should be no such behavior. When we have the breaking changes we
> > must
> > > make a PIP.
> > >
> > > > - Submit PIP changes
> > > > [feat][broker] PIP-198: Support xx
> > >
> > > Prefer [feat][broker][PIP-198] Support xx
> > >
> > >
> > > > - Cherry pick changes [4]
> > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9"
> in
> > > the
> > > > PR description.
> > >
> > > I prefer choice A.
> > >
> > > Thanks,
> > > Zixuan
> > >
> > >
> > > Zike Yang <zi...@apache.org> 于2022年8月18日周四 08:43写道：
> > >
> > > > LGTM.
> > > >
> > > > > - Cherry pick changes [4]
> > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
> branch-2.9"
> > in
> > > > the
> > > > > PR description.
> > > >
> > > > I prefer A.
> > > >
> > > > Thanks,
> > > > Zike Yang
> > > > Zike Yang
> > > >
> > > > On Wed, Aug 17, 2022 at 7:41 PM Qiang Huang <
> qiang.huang1991@gmail.com
> > >
> > > > wrote:
> > > > >
> > > > > Great work. I prefer "Choice A".
> > > > > > Cherry pick changes [4]
> > > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > >
> > > > > Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
> > > > >
> > > > > > LGTM.
> > > > > >
> > > > > > Thanks,
> > > > > > Yunze
> > > > > >
> > > > > >
> > > > > >
> > > > > >
> > > > > > > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
> > > > > > >
> > > > > > > Hi team,
> > > > > > >
> > > > > > > For PIP 198: Standardize PR Naming Convention using GitHub
> > Actions
> > > > [1]
> > > > > > >
> > > > > > > How to define [type] and [scope]? Do these abbreviations LGTY?
> > > > > > >
> > > > > > > *[Guide] Pulsar Pull Request Naming Convention* [2] contains
> > > > everything
> > > > > > > about the definition. Feel free to check and comment!
> > > > > > >
> > > > > > > ~~~~~~~~~~
> > > > > > >
> > > > > > > TL;DR
> > > > > > >
> > > > > > > PR title format: [type][scope] Summary [3]
> > > > > > >
> > > > > > > ~~~~~~~~~~
> > > > > > >
> > > > > > > [type]
> > > > > > >
> > > > > > > 1. Definition: what actions do you take?
> > > > > > >
> > > > > > > 2. It must be one of the following:
> > > > > > > - feat (abbr for "feature")
> > > > > > > - improve
> > > > > > > - fix
> > > > > > > - cleanup
> > > > > > > - refactor
> > > > > > > - revert
> > > > > > >
> > > > > > > ~~~~~~~~~~
> > > > > > >
> > > > > > > [scope]
> > > > > > >
> > > > > > > 1. Definition: where do you make changes?
> > > > > > >
> > > > > > > 2. It must be one of the following:
> > > > > > > - admin (changes to pulsar-admin, REST API, Java admin API)
> > > > > > > - broker
> > > > > > > - io
> > > > > > > - deploy
> > > > > > > - dep (abbr for dependency)
> > > > > > > - fcn (abbr for function)
> > > > > > > - monitor
> > > > > > > - pkg (abbr for package)
> > > > > > > - proxy
> > > > > > > - schema
> > > > > > > - sec (abbr for security)
> > > > > > > - sql
> > > > > > > - ts (abbr for tiered storage)
> > > > > > > - tool
> > > > > > > - txn (abbr for transaction)
> > > > > > >
> > > > > > > - java (changes to Java client)
> > > > > > > - cpp (changes to C++ client)
> > > > > > > - py (changes to Python client)
> > > > > > > - ws (changes to WebSocket)
> > > > > > > - rest (changes to REST)
> > > > > > >
> > > > > > > - test
> > > > > > > - ci
> > > > > > > - workflow
> > > > > > > - build
> > > > > > > - misc (abbr for miscellaneous)
> > > > > > >
> > > > > > > - doc
> > > > > > > - blog
> > > > > > > - site (abbr for website)
> > > > > > >
> > > > > > > ~~~~~~~~~~
> > > > > > >
> > > > > > > Besides, many developers have different opinions on the
> following
> > > > > > aspects.
> > > > > > > What's your writing preference?
> > > > > > >
> > > > > > > - Submit breaking changes
> > > > > > > [feat][broker]! Support xx
> > > > > > >
> > > > > > > - Submit PIP changes
> > > > > > > [feat][broker] PIP-198: Support xx
> > > > > > >
> > > > > > > - Cherry pick changes [4]
> > > > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
> > > branch-2.9"
> > > > in
> > > > > > the
> > > > > > > PR description.
> > > > > > >
> > > > > > > ~~~~~~~~~~
> > > > > > >
> > > > > > > Feel free to comment and make your voice heard. Go vote! Thank
> > you!
> > > > > > >
> > > > > > > [1]
> > > > > > >
> > > > > >
> > > >
> > >
> >
> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> > > > > > > [2]
> > > https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > > > > > > [3]
> > > > > > >
> > > > > >
> > > >
> > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > > > > > > [4]
> > > > > > >
> > > > > >
> > > >
> > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
> > > > > > >
> > > > > > > Yu
> > > > > >
> > > > > >
> > > > >
> > > > > --
> > > > > BR,
> > > > > Qiang Huang
> > > >
> > >
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Zixuan Liu <no...@gmail.com>.
> Since here uses a singular noun, how about using "dep"?
Sometimes we will update multiple dependencies so I want to use the `deps`.
> Are "security" and "tiered-storage" too long?
Although the word is very long, it will look very clear.
> "rest" here refers to client library REST [2]
And the "rest" you mentioned belongs to "admin", which includes
pulsar-admin, REST API, Java admin API [3]
It should be the same thing. If I make a mistake please tell me.
Thanks,
Zixuan
Yu <li...@apache.org> 于2022年8月18日周四 16:45写道：
> Thank you all!
>
> Hi Zixuan and all,
>
> > - dep (abbr for dependency) -> deps
> "dep" is abbr for "dependency"
> while "deps" can be abbr for "dependencies"
> Since here uses a singular noun, how about using "dep"?
>
> > - fcn (abbr for function) -> func
> +1
>
> > - sec (abbr for security) -> security
> > - ts (abbr for tiered storage) -> tiered-storage
> Are "security" and "tiered-storage" too long?
> - "sec" is commonly used in the science industry [1]
> - "ts" is suggested because you might know it refers to "tiered storage" at
> first glance
> since there seems to be no similar Pulsar concept/terminology
> that uses the same abbreviation.
>
> - rest (changes to REST) -> Using the `admin` instead of rest?
> "rest" here refers to client library REST [2]
> And the "rest" you mentioned belongs to "admin", which includes
> pulsar-admin, REST API, Java admin API [3]
>
> - misc (abbr for miscellaneous) -> chore?
> I'm OK with both choices.
> Hi other developers, what's your preference on this?
>
> [1] https://www.abbreviations.com/abbreviation/Security
> [2] https://pulsar.apache.org/docs/next/client-libraries-rest
> [3]
>
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
>
>
> Yu
>
> On Thu, Aug 18, 2022 at 10:50 AM Zixuan Liu <no...@gmail.com> wrote:
>
> > Thank yu for your work! Overall looks good to me, but I would like to
> > request changes.
> >
> > I prefer:
> >
> > - dep (abbr for dependency) -> deps
> > - fcn (abbr for function) -> func
> > - sec (abbr for security) -> security
> > - ts (abbr for tiered storage) -> tiered-storage
> > - txn (abbr for transaction)
> > - rest (changes to REST) -> Using the `admin` instead of rest?
> > - misc (abbr for miscellaneous) -> chore?
> >
> >
> > > - Submit breaking changes
> > > [feat][broker]! Support xx
> >
> > There should be no such behavior. When we have the breaking changes we
> must
> > make a PIP.
> >
> > > - Submit PIP changes
> > > [feat][broker] PIP-198: Support xx
> >
> > Prefer [feat][broker][PIP-198] Support xx
> >
> >
> > > - Cherry pick changes [4]
> > > Choice A: [fix][broker][branch-2.9] xxx
> > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> > the
> > > PR description.
> >
> > I prefer choice A.
> >
> > Thanks,
> > Zixuan
> >
> >
> > Zike Yang <zi...@apache.org> 于2022年8月18日周四 08:43写道：
> >
> > > LGTM.
> > >
> > > > - Cherry pick changes [4]
> > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9"
> in
> > > the
> > > > PR description.
> > >
> > > I prefer A.
> > >
> > > Thanks,
> > > Zike Yang
> > > Zike Yang
> > >
> > > On Wed, Aug 17, 2022 at 7:41 PM Qiang Huang <qiang.huang1991@gmail.com
> >
> > > wrote:
> > > >
> > > > Great work. I prefer "Choice A".
> > > > > Cherry pick changes [4]
> > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > >
> > > > Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
> > > >
> > > > > LGTM.
> > > > >
> > > > > Thanks,
> > > > > Yunze
> > > > >
> > > > >
> > > > >
> > > > >
> > > > > > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
> > > > > >
> > > > > > Hi team,
> > > > > >
> > > > > > For PIP 198: Standardize PR Naming Convention using GitHub
> Actions
> > > [1]
> > > > > >
> > > > > > How to define [type] and [scope]? Do these abbreviations LGTY?
> > > > > >
> > > > > > *[Guide] Pulsar Pull Request Naming Convention* [2] contains
> > > everything
> > > > > > about the definition. Feel free to check and comment!
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > TL;DR
> > > > > >
> > > > > > PR title format: [type][scope] Summary [3]
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > [type]
> > > > > >
> > > > > > 1. Definition: what actions do you take?
> > > > > >
> > > > > > 2. It must be one of the following:
> > > > > > - feat (abbr for "feature")
> > > > > > - improve
> > > > > > - fix
> > > > > > - cleanup
> > > > > > - refactor
> > > > > > - revert
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > [scope]
> > > > > >
> > > > > > 1. Definition: where do you make changes?
> > > > > >
> > > > > > 2. It must be one of the following:
> > > > > > - admin (changes to pulsar-admin, REST API, Java admin API)
> > > > > > - broker
> > > > > > - io
> > > > > > - deploy
> > > > > > - dep (abbr for dependency)
> > > > > > - fcn (abbr for function)
> > > > > > - monitor
> > > > > > - pkg (abbr for package)
> > > > > > - proxy
> > > > > > - schema
> > > > > > - sec (abbr for security)
> > > > > > - sql
> > > > > > - ts (abbr for tiered storage)
> > > > > > - tool
> > > > > > - txn (abbr for transaction)
> > > > > >
> > > > > > - java (changes to Java client)
> > > > > > - cpp (changes to C++ client)
> > > > > > - py (changes to Python client)
> > > > > > - ws (changes to WebSocket)
> > > > > > - rest (changes to REST)
> > > > > >
> > > > > > - test
> > > > > > - ci
> > > > > > - workflow
> > > > > > - build
> > > > > > - misc (abbr for miscellaneous)
> > > > > >
> > > > > > - doc
> > > > > > - blog
> > > > > > - site (abbr for website)
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > Besides, many developers have different opinions on the following
> > > > > aspects.
> > > > > > What's your writing preference?
> > > > > >
> > > > > > - Submit breaking changes
> > > > > > [feat][broker]! Support xx
> > > > > >
> > > > > > - Submit PIP changes
> > > > > > [feat][broker] PIP-198: Support xx
> > > > > >
> > > > > > - Cherry pick changes [4]
> > > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
> > branch-2.9"
> > > in
> > > > > the
> > > > > > PR description.
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > Feel free to comment and make your voice heard. Go vote! Thank
> you!
> > > > > >
> > > > > > [1]
> > > > > >
> > > > >
> > >
> >
> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> > > > > > [2]
> > https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > > > > > [3]
> > > > > >
> > > > >
> > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > > > > > [4]
> > > > > >
> > > > >
> > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
> > > > > >
> > > > > > Yu
> > > > >
> > > > >
> > > >
> > > > --
> > > > BR,
> > > > Qiang Huang
> > >
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by tison <wa...@gmail.com>.
Thanks for driving this discussion @Yu!
I'll go through the whole candidates tomorrow. When I try to use these
candidates now, I find one thing confusing and here is a quick question:
What's the difference between ci, workflow, and build? I make a change on
checkstyle rules, which one should I sort it to?
Best,
tison.
Yu <li...@apache.org> 于2022年8月18日周四 16:45写道：
> Thank you all!
>
> Hi Zixuan and all,
>
> > - dep (abbr for dependency) -> deps
> "dep" is abbr for "dependency"
> while "deps" can be abbr for "dependencies"
> Since here uses a singular noun, how about using "dep"?
>
> > - fcn (abbr for function) -> func
> +1
>
> > - sec (abbr for security) -> security
> > - ts (abbr for tiered storage) -> tiered-storage
> Are "security" and "tiered-storage" too long?
> - "sec" is commonly used in the science industry [1]
> - "ts" is suggested because you might know it refers to "tiered storage" at
> first glance
> since there seems to be no similar Pulsar concept/terminology
> that uses the same abbreviation.
>
> - rest (changes to REST) -> Using the `admin` instead of rest?
> "rest" here refers to client library REST [2]
> And the "rest" you mentioned belongs to "admin", which includes
> pulsar-admin, REST API, Java admin API [3]
>
> - misc (abbr for miscellaneous) -> chore?
> I'm OK with both choices.
> Hi other developers, what's your preference on this?
>
> [1] https://www.abbreviations.com/abbreviation/Security
> [2] https://pulsar.apache.org/docs/next/client-libraries-rest
> [3]
>
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
>
>
> Yu
>
> On Thu, Aug 18, 2022 at 10:50 AM Zixuan Liu <no...@gmail.com> wrote:
>
> > Thank yu for your work! Overall looks good to me, but I would like to
> > request changes.
> >
> > I prefer:
> >
> > - dep (abbr for dependency) -> deps
> > - fcn (abbr for function) -> func
> > - sec (abbr for security) -> security
> > - ts (abbr for tiered storage) -> tiered-storage
> > - txn (abbr for transaction)
> > - rest (changes to REST) -> Using the `admin` instead of rest?
> > - misc (abbr for miscellaneous) -> chore?
> >
> >
> > > - Submit breaking changes
> > > [feat][broker]! Support xx
> >
> > There should be no such behavior. When we have the breaking changes we
> must
> > make a PIP.
> >
> > > - Submit PIP changes
> > > [feat][broker] PIP-198: Support xx
> >
> > Prefer [feat][broker][PIP-198] Support xx
> >
> >
> > > - Cherry pick changes [4]
> > > Choice A: [fix][broker][branch-2.9] xxx
> > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> > the
> > > PR description.
> >
> > I prefer choice A.
> >
> > Thanks,
> > Zixuan
> >
> >
> > Zike Yang <zi...@apache.org> 于2022年8月18日周四 08:43写道：
> >
> > > LGTM.
> > >
> > > > - Cherry pick changes [4]
> > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9"
> in
> > > the
> > > > PR description.
> > >
> > > I prefer A.
> > >
> > > Thanks,
> > > Zike Yang
> > > Zike Yang
> > >
> > > On Wed, Aug 17, 2022 at 7:41 PM Qiang Huang <qiang.huang1991@gmail.com
> >
> > > wrote:
> > > >
> > > > Great work. I prefer "Choice A".
> > > > > Cherry pick changes [4]
> > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > >
> > > > Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
> > > >
> > > > > LGTM.
> > > > >
> > > > > Thanks,
> > > > > Yunze
> > > > >
> > > > >
> > > > >
> > > > >
> > > > > > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
> > > > > >
> > > > > > Hi team,
> > > > > >
> > > > > > For PIP 198: Standardize PR Naming Convention using GitHub
> Actions
> > > [1]
> > > > > >
> > > > > > How to define [type] and [scope]? Do these abbreviations LGTY?
> > > > > >
> > > > > > *[Guide] Pulsar Pull Request Naming Convention* [2] contains
> > > everything
> > > > > > about the definition. Feel free to check and comment!
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > TL;DR
> > > > > >
> > > > > > PR title format: [type][scope] Summary [3]
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > [type]
> > > > > >
> > > > > > 1. Definition: what actions do you take?
> > > > > >
> > > > > > 2. It must be one of the following:
> > > > > > - feat (abbr for "feature")
> > > > > > - improve
> > > > > > - fix
> > > > > > - cleanup
> > > > > > - refactor
> > > > > > - revert
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > [scope]
> > > > > >
> > > > > > 1. Definition: where do you make changes?
> > > > > >
> > > > > > 2. It must be one of the following:
> > > > > > - admin (changes to pulsar-admin, REST API, Java admin API)
> > > > > > - broker
> > > > > > - io
> > > > > > - deploy
> > > > > > - dep (abbr for dependency)
> > > > > > - fcn (abbr for function)
> > > > > > - monitor
> > > > > > - pkg (abbr for package)
> > > > > > - proxy
> > > > > > - schema
> > > > > > - sec (abbr for security)
> > > > > > - sql
> > > > > > - ts (abbr for tiered storage)
> > > > > > - tool
> > > > > > - txn (abbr for transaction)
> > > > > >
> > > > > > - java (changes to Java client)
> > > > > > - cpp (changes to C++ client)
> > > > > > - py (changes to Python client)
> > > > > > - ws (changes to WebSocket)
> > > > > > - rest (changes to REST)
> > > > > >
> > > > > > - test
> > > > > > - ci
> > > > > > - workflow
> > > > > > - build
> > > > > > - misc (abbr for miscellaneous)
> > > > > >
> > > > > > - doc
> > > > > > - blog
> > > > > > - site (abbr for website)
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > Besides, many developers have different opinions on the following
> > > > > aspects.
> > > > > > What's your writing preference?
> > > > > >
> > > > > > - Submit breaking changes
> > > > > > [feat][broker]! Support xx
> > > > > >
> > > > > > - Submit PIP changes
> > > > > > [feat][broker] PIP-198: Support xx
> > > > > >
> > > > > > - Cherry pick changes [4]
> > > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
> > branch-2.9"
> > > in
> > > > > the
> > > > > > PR description.
> > > > > >
> > > > > > ~~~~~~~~~~
> > > > > >
> > > > > > Feel free to comment and make your voice heard. Go vote! Thank
> you!
> > > > > >
> > > > > > [1]
> > > > > >
> > > > >
> > >
> >
> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> > > > > > [2]
> > https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > > > > > [3]
> > > > > >
> > > > >
> > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > > > > > [4]
> > > > > >
> > > > >
> > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
> > > > > >
> > > > > > Yu
> > > > >
> > > > >
> > > >
> > > > --
> > > > BR,
> > > > Qiang Huang
> > >
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yu <li...@apache.org>.
Thank you all!
Hi Zixuan and all,
> - dep (abbr for dependency) -> deps
"dep" is abbr for "dependency"
while "deps" can be abbr for "dependencies"
Since here uses a singular noun, how about using "dep"?
> - fcn (abbr for function) -> func
+1
> - sec (abbr for security) -> security
> - ts (abbr for tiered storage) -> tiered-storage
Are "security" and "tiered-storage" too long?
- "sec" is commonly used in the science industry [1]
- "ts" is suggested because you might know it refers to "tiered storage" at
first glance
since there seems to be no similar Pulsar concept/terminology
that uses the same abbreviation.
- rest (changes to REST) -> Using the `admin` instead of rest?
"rest" here refers to client library REST [2]
And the "rest" you mentioned belongs to "admin", which includes
pulsar-admin, REST API, Java admin API [3]
- misc (abbr for miscellaneous) -> chore?
I'm OK with both choices.
Hi other developers, what's your preference on this?
[1] https://www.abbreviations.com/abbreviation/Security
[2] https://pulsar.apache.org/docs/next/client-libraries-rest
[3]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.nnekhkthmwlh
Yu
On Thu, Aug 18, 2022 at 10:50 AM Zixuan Liu <no...@gmail.com> wrote:
> Thank yu for your work! Overall looks good to me, but I would like to
> request changes.
>
> I prefer:
>
> - dep (abbr for dependency) -> deps
> - fcn (abbr for function) -> func
> - sec (abbr for security) -> security
> - ts (abbr for tiered storage) -> tiered-storage
> - txn (abbr for transaction)
> - rest (changes to REST) -> Using the `admin` instead of rest?
> - misc (abbr for miscellaneous) -> chore?
>
>
> > - Submit breaking changes
> > [feat][broker]! Support xx
>
> There should be no such behavior. When we have the breaking changes we must
> make a PIP.
>
> > - Submit PIP changes
> > [feat][broker] PIP-198: Support xx
>
> Prefer [feat][broker][PIP-198] Support xx
>
>
> > - Cherry pick changes [4]
> > Choice A: [fix][broker][branch-2.9] xxx
> > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> the
> > PR description.
>
> I prefer choice A.
>
> Thanks,
> Zixuan
>
>
> Zike Yang <zi...@apache.org> 于2022年8月18日周四 08:43写道：
>
> > LGTM.
> >
> > > - Cherry pick changes [4]
> > > Choice A: [fix][broker][branch-2.9] xxx
> > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> > the
> > > PR description.
> >
> > I prefer A.
> >
> > Thanks,
> > Zike Yang
> > Zike Yang
> >
> > On Wed, Aug 17, 2022 at 7:41 PM Qiang Huang <qi...@gmail.com>
> > wrote:
> > >
> > > Great work. I prefer "Choice A".
> > > > Cherry pick changes [4]
> > > > Choice A: [fix][broker][branch-2.9] xxx
> > >
> > > Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
> > >
> > > > LGTM.
> > > >
> > > > Thanks,
> > > > Yunze
> > > >
> > > >
> > > >
> > > >
> > > > > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
> > > > >
> > > > > Hi team,
> > > > >
> > > > > For PIP 198: Standardize PR Naming Convention using GitHub Actions
> > [1]
> > > > >
> > > > > How to define [type] and [scope]? Do these abbreviations LGTY?
> > > > >
> > > > > *[Guide] Pulsar Pull Request Naming Convention* [2] contains
> > everything
> > > > > about the definition. Feel free to check and comment!
> > > > >
> > > > > ~~~~~~~~~~
> > > > >
> > > > > TL;DR
> > > > >
> > > > > PR title format: [type][scope] Summary [3]
> > > > >
> > > > > ~~~~~~~~~~
> > > > >
> > > > > [type]
> > > > >
> > > > > 1. Definition: what actions do you take?
> > > > >
> > > > > 2. It must be one of the following:
> > > > > - feat (abbr for "feature")
> > > > > - improve
> > > > > - fix
> > > > > - cleanup
> > > > > - refactor
> > > > > - revert
> > > > >
> > > > > ~~~~~~~~~~
> > > > >
> > > > > [scope]
> > > > >
> > > > > 1. Definition: where do you make changes?
> > > > >
> > > > > 2. It must be one of the following:
> > > > > - admin (changes to pulsar-admin, REST API, Java admin API)
> > > > > - broker
> > > > > - io
> > > > > - deploy
> > > > > - dep (abbr for dependency)
> > > > > - fcn (abbr for function)
> > > > > - monitor
> > > > > - pkg (abbr for package)
> > > > > - proxy
> > > > > - schema
> > > > > - sec (abbr for security)
> > > > > - sql
> > > > > - ts (abbr for tiered storage)
> > > > > - tool
> > > > > - txn (abbr for transaction)
> > > > >
> > > > > - java (changes to Java client)
> > > > > - cpp (changes to C++ client)
> > > > > - py (changes to Python client)
> > > > > - ws (changes to WebSocket)
> > > > > - rest (changes to REST)
> > > > >
> > > > > - test
> > > > > - ci
> > > > > - workflow
> > > > > - build
> > > > > - misc (abbr for miscellaneous)
> > > > >
> > > > > - doc
> > > > > - blog
> > > > > - site (abbr for website)
> > > > >
> > > > > ~~~~~~~~~~
> > > > >
> > > > > Besides, many developers have different opinions on the following
> > > > aspects.
> > > > > What's your writing preference?
> > > > >
> > > > > - Submit breaking changes
> > > > > [feat][broker]! Support xx
> > > > >
> > > > > - Submit PIP changes
> > > > > [feat][broker] PIP-198: Support xx
> > > > >
> > > > > - Cherry pick changes [4]
> > > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to
> branch-2.9"
> > in
> > > > the
> > > > > PR description.
> > > > >
> > > > > ~~~~~~~~~~
> > > > >
> > > > > Feel free to comment and make your voice heard. Go vote! Thank you!
> > > > >
> > > > > [1]
> > > > >
> > > >
> >
> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> > > > > [2]
> https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > > > > [3]
> > > > >
> > > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > > > > [4]
> > > > >
> > > >
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
> > > > >
> > > > > Yu
> > > >
> > > >
> > >
> > > --
> > > BR,
> > > Qiang Huang
> >
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Zixuan Liu <no...@gmail.com>.
Thank yu for your work! Overall looks good to me, but I would like to
request changes.
I prefer:
- dep (abbr for dependency) -> deps
- fcn (abbr for function) -> func
- sec (abbr for security) -> security
- ts (abbr for tiered storage) -> tiered-storage
- txn (abbr for transaction)
- rest (changes to REST) -> Using the `admin` instead of rest?
- misc (abbr for miscellaneous) -> chore?
> - Submit breaking changes
> [feat][broker]! Support xx
There should be no such behavior. When we have the breaking changes we must
make a PIP.
> - Submit PIP changes
> [feat][broker] PIP-198: Support xx
Prefer [feat][broker][PIP-198] Support xx
> - Cherry pick changes [4]
> Choice A: [fix][broker][branch-2.9] xxx
> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
the
> PR description.
I prefer choice A.
Thanks,
Zixuan
Zike Yang <zi...@apache.org> 于2022年8月18日周四 08:43写道：
> LGTM.
>
> > - Cherry pick changes [4]
> > Choice A: [fix][broker][branch-2.9] xxx
> > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> the
> > PR description.
>
> I prefer A.
>
> Thanks,
> Zike Yang
> Zike Yang
>
> On Wed, Aug 17, 2022 at 7:41 PM Qiang Huang <qi...@gmail.com>
> wrote:
> >
> > Great work. I prefer "Choice A".
> > > Cherry pick changes [4]
> > > Choice A: [fix][broker][branch-2.9] xxx
> >
> > Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
> >
> > > LGTM.
> > >
> > > Thanks,
> > > Yunze
> > >
> > >
> > >
> > >
> > > > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
> > > >
> > > > Hi team,
> > > >
> > > > For PIP 198: Standardize PR Naming Convention using GitHub Actions
> [1]
> > > >
> > > > How to define [type] and [scope]? Do these abbreviations LGTY?
> > > >
> > > > *[Guide] Pulsar Pull Request Naming Convention* [2] contains
> everything
> > > > about the definition. Feel free to check and comment!
> > > >
> > > > ~~~~~~~~~~
> > > >
> > > > TL;DR
> > > >
> > > > PR title format: [type][scope] Summary [3]
> > > >
> > > > ~~~~~~~~~~
> > > >
> > > > [type]
> > > >
> > > > 1. Definition: what actions do you take?
> > > >
> > > > 2. It must be one of the following:
> > > > - feat (abbr for "feature")
> > > > - improve
> > > > - fix
> > > > - cleanup
> > > > - refactor
> > > > - revert
> > > >
> > > > ~~~~~~~~~~
> > > >
> > > > [scope]
> > > >
> > > > 1. Definition: where do you make changes?
> > > >
> > > > 2. It must be one of the following:
> > > > - admin (changes to pulsar-admin, REST API, Java admin API)
> > > > - broker
> > > > - io
> > > > - deploy
> > > > - dep (abbr for dependency)
> > > > - fcn (abbr for function)
> > > > - monitor
> > > > - pkg (abbr for package)
> > > > - proxy
> > > > - schema
> > > > - sec (abbr for security)
> > > > - sql
> > > > - ts (abbr for tiered storage)
> > > > - tool
> > > > - txn (abbr for transaction)
> > > >
> > > > - java (changes to Java client)
> > > > - cpp (changes to C++ client)
> > > > - py (changes to Python client)
> > > > - ws (changes to WebSocket)
> > > > - rest (changes to REST)
> > > >
> > > > - test
> > > > - ci
> > > > - workflow
> > > > - build
> > > > - misc (abbr for miscellaneous)
> > > >
> > > > - doc
> > > > - blog
> > > > - site (abbr for website)
> > > >
> > > > ~~~~~~~~~~
> > > >
> > > > Besides, many developers have different opinions on the following
> > > aspects.
> > > > What's your writing preference?
> > > >
> > > > - Submit breaking changes
> > > > [feat][broker]! Support xx
> > > >
> > > > - Submit PIP changes
> > > > [feat][broker] PIP-198: Support xx
> > > >
> > > > - Cherry pick changes [4]
> > > > Choice A: [fix][broker][branch-2.9] xxx
> > > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9"
> in
> > > the
> > > > PR description.
> > > >
> > > > ~~~~~~~~~~
> > > >
> > > > Feel free to comment and make your voice heard. Go vote! Thank you!
> > > >
> > > > [1]
> > > >
> > >
> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> > > > [2] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > > > [3]
> > > >
> > >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > > > [4]
> > > >
> > >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
> > > >
> > > > Yu
> > >
> > >
> >
> > --
> > BR,
> > Qiang Huang
>
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Zike Yang <zi...@apache.org>.
LGTM.
> - Cherry pick changes [4]
> Choice A: [fix][broker][branch-2.9] xxx
> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in the
> PR description.
I prefer A.
Thanks,
Zike Yang
Zike Yang
On Wed, Aug 17, 2022 at 7:41 PM Qiang Huang <qi...@gmail.com> wrote:
>
> Great work. I prefer "Choice A".
> > Cherry pick changes [4]
> > Choice A: [fix][broker][branch-2.9] xxx
>
> Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
>
> > LGTM.
> >
> > Thanks,
> > Yunze
> >
> >
> >
> >
> > > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
> > >
> > > Hi team,
> > >
> > > For PIP 198: Standardize PR Naming Convention using GitHub Actions [1]
> > >
> > > How to define [type] and [scope]? Do these abbreviations LGTY?
> > >
> > > *[Guide] Pulsar Pull Request Naming Convention* [2] contains everything
> > > about the definition. Feel free to check and comment!
> > >
> > > ~~~~~~~~~~
> > >
> > > TL;DR
> > >
> > > PR title format: [type][scope] Summary [3]
> > >
> > > ~~~~~~~~~~
> > >
> > > [type]
> > >
> > > 1. Definition: what actions do you take?
> > >
> > > 2. It must be one of the following:
> > > - feat (abbr for "feature")
> > > - improve
> > > - fix
> > > - cleanup
> > > - refactor
> > > - revert
> > >
> > > ~~~~~~~~~~
> > >
> > > [scope]
> > >
> > > 1. Definition: where do you make changes?
> > >
> > > 2. It must be one of the following:
> > > - admin (changes to pulsar-admin, REST API, Java admin API)
> > > - broker
> > > - io
> > > - deploy
> > > - dep (abbr for dependency)
> > > - fcn (abbr for function)
> > > - monitor
> > > - pkg (abbr for package)
> > > - proxy
> > > - schema
> > > - sec (abbr for security)
> > > - sql
> > > - ts (abbr for tiered storage)
> > > - tool
> > > - txn (abbr for transaction)
> > >
> > > - java (changes to Java client)
> > > - cpp (changes to C++ client)
> > > - py (changes to Python client)
> > > - ws (changes to WebSocket)
> > > - rest (changes to REST)
> > >
> > > - test
> > > - ci
> > > - workflow
> > > - build
> > > - misc (abbr for miscellaneous)
> > >
> > > - doc
> > > - blog
> > > - site (abbr for website)
> > >
> > > ~~~~~~~~~~
> > >
> > > Besides, many developers have different opinions on the following
> > aspects.
> > > What's your writing preference?
> > >
> > > - Submit breaking changes
> > > [feat][broker]! Support xx
> > >
> > > - Submit PIP changes
> > > [feat][broker] PIP-198: Support xx
> > >
> > > - Cherry pick changes [4]
> > > Choice A: [fix][broker][branch-2.9] xxx
> > > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> > the
> > > PR description.
> > >
> > > ~~~~~~~~~~
> > >
> > > Feel free to comment and make your voice heard. Go vote! Thank you!
> > >
> > > [1]
> > >
> > https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> > > [2] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > > [3]
> > >
> > https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > > [4]
> > >
> > https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
> > >
> > > Yu
> >
> >
>
> --
> BR,
> Qiang Huang
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Qiang Huang <qi...@gmail.com>.
Great work. I prefer "Choice A".
> Cherry pick changes [4]
> Choice A: [fix][broker][branch-2.9] xxx
Yunze Xu <yz...@streamnative.io.invalid> 于2022年8月17日周三 18:32写道：
> LGTM.
>
> Thanks,
> Yunze
>
>
>
>
> > 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
> >
> > Hi team,
> >
> > For PIP 198: Standardize PR Naming Convention using GitHub Actions [1]
> >
> > How to define [type] and [scope]? Do these abbreviations LGTY?
> >
> > *[Guide] Pulsar Pull Request Naming Convention* [2] contains everything
> > about the definition. Feel free to check and comment!
> >
> > ~~~~~~~~~~
> >
> > TL;DR
> >
> > PR title format: [type][scope] Summary [3]
> >
> > ~~~~~~~~~~
> >
> > [type]
> >
> > 1. Definition: what actions do you take?
> >
> > 2. It must be one of the following:
> > - feat (abbr for "feature")
> > - improve
> > - fix
> > - cleanup
> > - refactor
> > - revert
> >
> > ~~~~~~~~~~
> >
> > [scope]
> >
> > 1. Definition: where do you make changes?
> >
> > 2. It must be one of the following:
> > - admin (changes to pulsar-admin, REST API, Java admin API)
> > - broker
> > - io
> > - deploy
> > - dep (abbr for dependency)
> > - fcn (abbr for function)
> > - monitor
> > - pkg (abbr for package)
> > - proxy
> > - schema
> > - sec (abbr for security)
> > - sql
> > - ts (abbr for tiered storage)
> > - tool
> > - txn (abbr for transaction)
> >
> > - java (changes to Java client)
> > - cpp (changes to C++ client)
> > - py (changes to Python client)
> > - ws (changes to WebSocket)
> > - rest (changes to REST)
> >
> > - test
> > - ci
> > - workflow
> > - build
> > - misc (abbr for miscellaneous)
> >
> > - doc
> > - blog
> > - site (abbr for website)
> >
> > ~~~~~~~~~~
> >
> > Besides, many developers have different opinions on the following
> aspects.
> > What's your writing preference?
> >
> > - Submit breaking changes
> > [feat][broker]! Support xx
> >
> > - Submit PIP changes
> > [feat][broker] PIP-198: Support xx
> >
> > - Cherry pick changes [4]
> > Choice A: [fix][broker][branch-2.9] xxx
> > Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in
> the
> > PR description.
> >
> > ~~~~~~~~~~
> >
> > Feel free to comment and make your voice heard. Go vote! Thank you!
> >
> > [1]
> >
> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> > [2] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> > [3]
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> > [4]
> >
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
> >
> > Yu
>
>
--
BR,
Qiang Huang
Re: [Discussion] PIP 198 - How to define [type] and [scope]?
Posted by Yunze Xu <yz...@streamnative.io.INVALID>.
LGTM.
Thanks,
Yunze
> 2022年8月17日 11:15，Yu <li...@apache.org> 写道：
>
> Hi team,
>
> For PIP 198: Standardize PR Naming Convention using GitHub Actions [1]
>
> How to define [type] and [scope]? Do these abbreviations LGTY?
>
> *[Guide] Pulsar Pull Request Naming Convention* [2] contains everything
> about the definition. Feel free to check and comment!
>
> ~~~~~~~~~~
>
> TL;DR
>
> PR title format: [type][scope] Summary [3]
>
> ~~~~~~~~~~
>
> [type]
>
> 1. Definition: what actions do you take?
>
> 2. It must be one of the following:
> - feat (abbr for "feature")
> - improve
> - fix
> - cleanup
> - refactor
> - revert
>
> ~~~~~~~~~~
>
> [scope]
>
> 1. Definition: where do you make changes?
>
> 2. It must be one of the following:
> - admin (changes to pulsar-admin, REST API, Java admin API)
> - broker
> - io
> - deploy
> - dep (abbr for dependency)
> - fcn (abbr for function)
> - monitor
> - pkg (abbr for package)
> - proxy
> - schema
> - sec (abbr for security)
> - sql
> - ts (abbr for tiered storage)
> - tool
> - txn (abbr for transaction)
>
> - java (changes to Java client)
> - cpp (changes to C++ client)
> - py (changes to Python client)
> - ws (changes to WebSocket)
> - rest (changes to REST)
>
> - test
> - ci
> - workflow
> - build
> - misc (abbr for miscellaneous)
>
> - doc
> - blog
> - site (abbr for website)
>
> ~~~~~~~~~~
>
> Besides, many developers have different opinions on the following aspects.
> What's your writing preference?
>
> - Submit breaking changes
> [feat][broker]! Support xx
>
> - Submit PIP changes
> [feat][broker] PIP-198: Support xx
>
> - Cherry pick changes [4]
> Choice A: [fix][broker][branch-2.9] xxx
> Choice B: [fix][broker] xxx. And add "cherry pick xxx to branch-2.9" in the
> PR description.
>
> ~~~~~~~~~~
>
> Feel free to comment and make your voice heard. Go vote! Thank you!
>
> [1]
> https://docs.google.com/document/d/1sJlUNAHnYAbvu9UtEgCrn_oVTnVc1M5nHC19x1bFab4/edit
> [2] https://lists.apache.org/thread/90rcjf1dv0fbkb5hm31kmgr65fj0nfnn
> [3]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=id.y8943h392zno
> [4]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit?pli=1#bookmark=kix.849jztd92uk7
>
> Yu