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 <node...@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 <node...@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 <z...@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.huang1...@gmail.com
>> > >
>> > > > wrote:
>> > > > >
>> > > > > Great work. I prefer "Choice A".
>> > > > > > Cherry pick changes [4]
>> > > > > > Choice A: [fix][broker][branch-2.9] xxx
>> > > > >
>> > > > > Yunze Xu <y...@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
>> > > >
>> > >
>> >
>>
>

Reply via email to