You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by Kiryl Valkovich <vi...@gmail.com> on 2024/03/18 13:37:21 UTC
Suggestions on GitHub labels and issue templates
Comment with better formatting on GitHub: https://github.com/apache/pulsar/issues/22277#issuecomment-2002553745
• Deprecate java label. Pulsar is written in Java and most PRs update Java code.
• Instead of removing labels, deprecate them by renaming them to deprecated/<label_name>. Probably pick another prefix that is alphabetically closer to the end of the alphabet to reduce noise.
• Add go label automatically using labeler: https://github.com/apache/pulsar/blob/master/.github/labeler.yml
go:
- changed-files:
- any-glob-to-any-file: '**/*.go'
• Add component/* labels automatically based on the file path
component/config:
- changed-files:
- any-glob-to-any-file: 'conf/**/*'
- any-glob-to-any-file: 'pulsar-config-validation/**/*'
component/client:
- changed-files:
- any-glob-to-any-file: 'pulsar-client/**/*'
- any-glob-to-any-file: 'pulsar-client-*/**/*'
...
• Rename bug label to type/bug for consistency. Keep the red color.
• (?) Rename component/* => area/* for shorter names. The https://github.com/kubernetes/kubernetes/labels has such naming.
• Rename doc-required label to type/doc. Relabel open issues and PRs with doc labels to the type/doc.
• Deprecate all other doc-* labels. If it is needed for some kind of workflow, simply use the board project with ToDo -> In Progress -> Done states.
• (?) Probably it makes sense to enable and track website and docs issues in apache/pulsar-site repository. And add a good visible link to apache/pulsar README.md.
• Deprecate the question label. Instead, move such issues to Discussions -> Q&A
• Migrate issues with the enhancement either to type/feature label or Discussions. Add a new Suggest an idea issue template that redirects to the Discussions -> Ideas
• (?) Rename PIP => type/PIP for consistency
• Rename flaky-test => type/flaky-test to consistency
• Deprecate lifecycle/stale label. Use Stale instead. Rename Stale => stale for consistency.
• Add the ability to pick an area/* label from the dropdown on issue creation.
systemd/systemd and a few other projects use this action for that: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler?tab=readme-ov-file#real-life-examples
Best,
Kiryl
Re: Suggestions on GitHub labels and issue templates
Posted by Lari Hotari <lh...@apache.org>.
Thanks Kiryl, very good proposal.
> • (?) Probably it makes sense to enable and track website and docs issues in apache/pulsar-site repository. And add a good visible link to apache/pulsar README.md.
Yes, that would work too. Since the issue reporting for docs has been
centralized to apache/pulsar in the past, I don't think that it's a
great idea to move it back to pulsar-site, unless there's a compelling
reason. Instead of moving the location of website and docs issues, we
could improve the template for docs issues and add a template for
website issues.
-Lari
On Mon, 18 Mar 2024 at 15:39, Kiryl Valkovich <vi...@gmail.com> wrote:
>
> Comment with better formatting on GitHub: https://github.com/apache/pulsar/issues/22277#issuecomment-2002553745
>
> • Deprecate java label. Pulsar is written in Java and most PRs update Java code.
> • Instead of removing labels, deprecate them by renaming them to deprecated/<label_name>. Probably pick another prefix that is alphabetically closer to the end of the alphabet to reduce noise.
> • Add go label automatically using labeler: https://github.com/apache/pulsar/blob/master/.github/labeler.yml
> go:
> - changed-files:
> - any-glob-to-any-file: '**/*.go'
>
> • Add component/* labels automatically based on the file path
> component/config:
> - changed-files:
> - any-glob-to-any-file: 'conf/**/*'
> - any-glob-to-any-file: 'pulsar-config-validation/**/*'
> component/client:
> - changed-files:
> - any-glob-to-any-file: 'pulsar-client/**/*'
> - any-glob-to-any-file: 'pulsar-client-*/**/*'
> ...
>
> • Rename bug label to type/bug for consistency. Keep the red color.
> • (?) Rename component/* => area/* for shorter names. The https://github.com/kubernetes/kubernetes/labels has such naming.
> • Rename doc-required label to type/doc. Relabel open issues and PRs with doc labels to the type/doc.
> • Deprecate all other doc-* labels. If it is needed for some kind of workflow, simply use the board project with ToDo -> In Progress -> Done states.
> • (?) Probably it makes sense to enable and track website and docs issues in apache/pulsar-site repository. And add a good visible link to apache/pulsar README.md.
> • Deprecate the question label. Instead, move such issues to Discussions -> Q&A
> • Migrate issues with the enhancement either to type/feature label or Discussions. Add a new Suggest an idea issue template that redirects to the Discussions -> Ideas
> • (?) Rename PIP => type/PIP for consistency
> • Rename flaky-test => type/flaky-test to consistency
> • Deprecate lifecycle/stale label. Use Stale instead. Rename Stale => stale for consistency.
> • Add the ability to pick an area/* label from the dropdown on issue creation.
> systemd/systemd and a few other projects use this action for that: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler?tab=readme-ov-file#real-life-examples
>
>
> Best,
> Kiryl
>
Re: Suggestions on GitHub labels and issue templates
Posted by PengHui Li <pe...@apache.org>.
The labels updates:
- Removed the `java` label. We only have a few legacy PRs labeled with
`java`.
- Changed `component/*` to `area/*`
- Deprecated `question` label
- Changed `PIP` to `type/PIP`
- Changed `flaky-test` to `type/flaky-test`
On Mon, Mar 25, 2024 at 3:17 PM PengHui Li <pe...@apache.org> wrote:
> Yes, the PR is welcome.
>
> Best,
> Penghui
>
> On Mon, Mar 25, 2024 at 3:08 PM Kiryl Valkovich <vi...@gmail.com>
> wrote:
>
>> Hi PengHui,
>> Sure. If the PR is welcome here, I’ll submit it in a few days.
>>
>>
>> Best,
>> Kiryl
>>
>> > On Mar 25, 2024, at 6:07 AM, PengHui Li <pe...@apache.org> wrote:
>> >
>> > Hi Kiryl,
>> >
>> > Thanks for your suggestions, and they are looking good to me
>> > I'll follow your suggestions on renaming or deprecating the labels.
>> >
>> > For the label automation, do you want to push a PR to add it?
>> >
>> > Regards,
>> > Penghui
>> >
>> >
>> > On Mon, Mar 18, 2024 at 9:39 PM Kiryl Valkovich <vi...@gmail.com>
>> > wrote:
>> >
>> >> Comment with better formatting on GitHub:
>> >> https://github.com/apache/pulsar/issues/22277#issuecomment-2002553745
>> >>
>> >> • Deprecate java label. Pulsar is written in Java and most PRs
>> update
>> >> Java code.
>> >> • Instead of removing labels, deprecate them by renaming them to
>> >> deprecated/<label_name>. Probably pick another prefix that is
>> >> alphabetically closer to the end of the alphabet to reduce noise.
>> >> • Add go label automatically using labeler:
>> >> https://github.com/apache/pulsar/blob/master/.github/labeler.yml
>> >> go:
>> >> - changed-files:
>> >> - any-glob-to-any-file: '**/*.go'
>> >>
>> >> • Add component/* labels automatically based on the file path
>> >> component/config:
>> >> - changed-files:
>> >> - any-glob-to-any-file: 'conf/**/*'
>> >> - any-glob-to-any-file: 'pulsar-config-validation/**/*'
>> >> component/client:
>> >> - changed-files:
>> >> - any-glob-to-any-file: 'pulsar-client/**/*'
>> >> - any-glob-to-any-file: 'pulsar-client-*/**/*'
>> >> ...
>> >>
>> >> • Rename bug label to type/bug for consistency. Keep the red color.
>> >> • (?) Rename component/* => area/* for shorter names. The
>> >> https://github.com/kubernetes/kubernetes/labels has such naming.
>> >> • Rename doc-required label to type/doc. Relabel open issues and PRs
>> >> with doc labels to the type/doc.
>> >> • Deprecate all other doc-* labels. If it is needed for some kind of
>> >> workflow, simply use the board project with ToDo -> In Progress -> Done
>> >> states.
>> >> • (?) Probably it makes sense to enable and track website and docs
>> >> issues in apache/pulsar-site repository. And add a good visible link to
>> >> apache/pulsar README.md.
>> >> • Deprecate the question label. Instead, move such issues to
>> >> Discussions -> Q&A
>> >> • Migrate issues with the enhancement either to type/feature label
>> or
>> >> Discussions. Add a new Suggest an idea issue template that redirects
>> to the
>> >> Discussions -> Ideas
>> >> • (?) Rename PIP => type/PIP for consistency
>> >> • Rename flaky-test => type/flaky-test to consistency
>> >> • Deprecate lifecycle/stale label. Use Stale instead. Rename Stale
>> =>
>> >> stale for consistency.
>> >> • Add the ability to pick an area/* label from the dropdown on issue
>> >> creation.
>> >> systemd/systemd and a few other projects use this action for that:
>> >>
>> https://github.com/redhat-plumbers-in-action/advanced-issue-labeler?tab=readme-ov-file#real-life-examples
>> >>
>> >>
>> >> Best,
>> >> Kiryl
>> >>
>> >>
>>
>>
Re: Suggestions on GitHub labels and issue templates
Posted by PengHui Li <pe...@apache.org>.
Yes, the PR is welcome.
Best,
Penghui
On Mon, Mar 25, 2024 at 3:08 PM Kiryl Valkovich <vi...@gmail.com>
wrote:
> Hi PengHui,
> Sure. If the PR is welcome here, I’ll submit it in a few days.
>
>
> Best,
> Kiryl
>
> > On Mar 25, 2024, at 6:07 AM, PengHui Li <pe...@apache.org> wrote:
> >
> > Hi Kiryl,
> >
> > Thanks for your suggestions, and they are looking good to me
> > I'll follow your suggestions on renaming or deprecating the labels.
> >
> > For the label automation, do you want to push a PR to add it?
> >
> > Regards,
> > Penghui
> >
> >
> > On Mon, Mar 18, 2024 at 9:39 PM Kiryl Valkovich <vi...@gmail.com>
> > wrote:
> >
> >> Comment with better formatting on GitHub:
> >> https://github.com/apache/pulsar/issues/22277#issuecomment-2002553745
> >>
> >> • Deprecate java label. Pulsar is written in Java and most PRs update
> >> Java code.
> >> • Instead of removing labels, deprecate them by renaming them to
> >> deprecated/<label_name>. Probably pick another prefix that is
> >> alphabetically closer to the end of the alphabet to reduce noise.
> >> • Add go label automatically using labeler:
> >> https://github.com/apache/pulsar/blob/master/.github/labeler.yml
> >> go:
> >> - changed-files:
> >> - any-glob-to-any-file: '**/*.go'
> >>
> >> • Add component/* labels automatically based on the file path
> >> component/config:
> >> - changed-files:
> >> - any-glob-to-any-file: 'conf/**/*'
> >> - any-glob-to-any-file: 'pulsar-config-validation/**/*'
> >> component/client:
> >> - changed-files:
> >> - any-glob-to-any-file: 'pulsar-client/**/*'
> >> - any-glob-to-any-file: 'pulsar-client-*/**/*'
> >> ...
> >>
> >> • Rename bug label to type/bug for consistency. Keep the red color.
> >> • (?) Rename component/* => area/* for shorter names. The
> >> https://github.com/kubernetes/kubernetes/labels has such naming.
> >> • Rename doc-required label to type/doc. Relabel open issues and PRs
> >> with doc labels to the type/doc.
> >> • Deprecate all other doc-* labels. If it is needed for some kind of
> >> workflow, simply use the board project with ToDo -> In Progress -> Done
> >> states.
> >> • (?) Probably it makes sense to enable and track website and docs
> >> issues in apache/pulsar-site repository. And add a good visible link to
> >> apache/pulsar README.md.
> >> • Deprecate the question label. Instead, move such issues to
> >> Discussions -> Q&A
> >> • Migrate issues with the enhancement either to type/feature label or
> >> Discussions. Add a new Suggest an idea issue template that redirects to
> the
> >> Discussions -> Ideas
> >> • (?) Rename PIP => type/PIP for consistency
> >> • Rename flaky-test => type/flaky-test to consistency
> >> • Deprecate lifecycle/stale label. Use Stale instead. Rename Stale =>
> >> stale for consistency.
> >> • Add the ability to pick an area/* label from the dropdown on issue
> >> creation.
> >> systemd/systemd and a few other projects use this action for that:
> >>
> https://github.com/redhat-plumbers-in-action/advanced-issue-labeler?tab=readme-ov-file#real-life-examples
> >>
> >>
> >> Best,
> >> Kiryl
> >>
> >>
>
>
Re: Suggestions on GitHub labels and issue templates
Posted by Kiryl Valkovich <vi...@gmail.com>.
Hi PengHui,
Sure. If the PR is welcome here, I’ll submit it in a few days.
Best,
Kiryl
> On Mar 25, 2024, at 6:07 AM, PengHui Li <pe...@apache.org> wrote:
>
> Hi Kiryl,
>
> Thanks for your suggestions, and they are looking good to me
> I'll follow your suggestions on renaming or deprecating the labels.
>
> For the label automation, do you want to push a PR to add it?
>
> Regards,
> Penghui
>
>
> On Mon, Mar 18, 2024 at 9:39 PM Kiryl Valkovich <vi...@gmail.com>
> wrote:
>
>> Comment with better formatting on GitHub:
>> https://github.com/apache/pulsar/issues/22277#issuecomment-2002553745
>>
>> • Deprecate java label. Pulsar is written in Java and most PRs update
>> Java code.
>> • Instead of removing labels, deprecate them by renaming them to
>> deprecated/<label_name>. Probably pick another prefix that is
>> alphabetically closer to the end of the alphabet to reduce noise.
>> • Add go label automatically using labeler:
>> https://github.com/apache/pulsar/blob/master/.github/labeler.yml
>> go:
>> - changed-files:
>> - any-glob-to-any-file: '**/*.go'
>>
>> • Add component/* labels automatically based on the file path
>> component/config:
>> - changed-files:
>> - any-glob-to-any-file: 'conf/**/*'
>> - any-glob-to-any-file: 'pulsar-config-validation/**/*'
>> component/client:
>> - changed-files:
>> - any-glob-to-any-file: 'pulsar-client/**/*'
>> - any-glob-to-any-file: 'pulsar-client-*/**/*'
>> ...
>>
>> • Rename bug label to type/bug for consistency. Keep the red color.
>> • (?) Rename component/* => area/* for shorter names. The
>> https://github.com/kubernetes/kubernetes/labels has such naming.
>> • Rename doc-required label to type/doc. Relabel open issues and PRs
>> with doc labels to the type/doc.
>> • Deprecate all other doc-* labels. If it is needed for some kind of
>> workflow, simply use the board project with ToDo -> In Progress -> Done
>> states.
>> • (?) Probably it makes sense to enable and track website and docs
>> issues in apache/pulsar-site repository. And add a good visible link to
>> apache/pulsar README.md.
>> • Deprecate the question label. Instead, move such issues to
>> Discussions -> Q&A
>> • Migrate issues with the enhancement either to type/feature label or
>> Discussions. Add a new Suggest an idea issue template that redirects to the
>> Discussions -> Ideas
>> • (?) Rename PIP => type/PIP for consistency
>> • Rename flaky-test => type/flaky-test to consistency
>> • Deprecate lifecycle/stale label. Use Stale instead. Rename Stale =>
>> stale for consistency.
>> • Add the ability to pick an area/* label from the dropdown on issue
>> creation.
>> systemd/systemd and a few other projects use this action for that:
>> https://github.com/redhat-plumbers-in-action/advanced-issue-labeler?tab=readme-ov-file#real-life-examples
>>
>>
>> Best,
>> Kiryl
>>
>>
Re: Suggestions on GitHub labels and issue templates
Posted by PengHui Li <pe...@apache.org>.
Hi Kiryl,
Thanks for your suggestions, and they are looking good to me
I'll follow your suggestions on renaming or deprecating the labels.
For the label automation, do you want to push a PR to add it?
Regards,
Penghui
On Mon, Mar 18, 2024 at 9:39 PM Kiryl Valkovich <vi...@gmail.com>
wrote:
> Comment with better formatting on GitHub:
> https://github.com/apache/pulsar/issues/22277#issuecomment-2002553745
>
> • Deprecate java label. Pulsar is written in Java and most PRs update
> Java code.
> • Instead of removing labels, deprecate them by renaming them to
> deprecated/<label_name>. Probably pick another prefix that is
> alphabetically closer to the end of the alphabet to reduce noise.
> • Add go label automatically using labeler:
> https://github.com/apache/pulsar/blob/master/.github/labeler.yml
> go:
> - changed-files:
> - any-glob-to-any-file: '**/*.go'
>
> • Add component/* labels automatically based on the file path
> component/config:
> - changed-files:
> - any-glob-to-any-file: 'conf/**/*'
> - any-glob-to-any-file: 'pulsar-config-validation/**/*'
> component/client:
> - changed-files:
> - any-glob-to-any-file: 'pulsar-client/**/*'
> - any-glob-to-any-file: 'pulsar-client-*/**/*'
> ...
>
> • Rename bug label to type/bug for consistency. Keep the red color.
> • (?) Rename component/* => area/* for shorter names. The
> https://github.com/kubernetes/kubernetes/labels has such naming.
> • Rename doc-required label to type/doc. Relabel open issues and PRs
> with doc labels to the type/doc.
> • Deprecate all other doc-* labels. If it is needed for some kind of
> workflow, simply use the board project with ToDo -> In Progress -> Done
> states.
> • (?) Probably it makes sense to enable and track website and docs
> issues in apache/pulsar-site repository. And add a good visible link to
> apache/pulsar README.md.
> • Deprecate the question label. Instead, move such issues to
> Discussions -> Q&A
> • Migrate issues with the enhancement either to type/feature label or
> Discussions. Add a new Suggest an idea issue template that redirects to the
> Discussions -> Ideas
> • (?) Rename PIP => type/PIP for consistency
> • Rename flaky-test => type/flaky-test to consistency
> • Deprecate lifecycle/stale label. Use Stale instead. Rename Stale =>
> stale for consistency.
> • Add the ability to pick an area/* label from the dropdown on issue
> creation.
> systemd/systemd and a few other projects use this action for that:
> https://github.com/redhat-plumbers-in-action/advanced-issue-labeler?tab=readme-ov-file#real-life-examples
>
>
> Best,
> Kiryl
>
>