You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@streampark.apache.org by caican cai <ca...@gmail.com> on 2024/01/06 12:21:05 UTC

Specifications about PR

Hello everyone, since joining the Streampark community, I have observed
that PR submissions in the Streampark community are very irregular, which
is very unfavorable for regulation and new developers to learn. For
example, the PR title should be limited to the words [Fix], [Feature], etc. The
first letter of words should be capitalized. We should also add words such
as [Hotfix] including some simple repairs. I would like to ask your opinion.

Best wish,
Caican Cai

Re: Specifications about PR

Posted by Huajie Wang <be...@apache.org>.

hi caican:

Thanks very much for your feedback. Considering that many developers
in the community are new or unfamiliar with open source rules, So, In
most cases, if the PR is ok, there won't be some restrictions.
Perhaps we can modify these titles when merging PRs in our PMC member
or committer.


Best,
Huajie Wang



caican cai <ca...@gmail.com> 于2024年1月6日周六 20:31写道：

> Here are some PRs that I think are irregular:
> https://github.com/apache/incubator-streampark/pull/3429
> https://github.com/apache/incubator-streampark/pull/3432
>
> caican cai <ca...@gmail.com> 于2024年1月6日周六 20:21写道：
>
> > Hello everyone, since joining the Streampark community, I have observed
> > that PR submissions in the Streampark community are very irregular, which
> > is very unfavorable for regulation and new developers to learn. For
> > example, the PR title should be limited to the words [Fix], [Feature],
> etc. The
> > first letter of words should be capitalized. We should also add words
> such
> > as [Hotfix] including some simple repairs. I would like to ask your
> opinion.
> >
> > Best wish,
> > Caican Cai
> >
>

Re: Specifications about PR

Posted by caican cai <ca...@gmail.com>.

Here are some PRs that I think are irregular:
https://github.com/apache/incubator-streampark/pull/3429
https://github.com/apache/incubator-streampark/pull/3432

caican cai <ca...@gmail.com> 于2024年1月6日周六 20:21写道：

> Hello everyone, since joining the Streampark community, I have observed
> that PR submissions in the Streampark community are very irregular, which
> is very unfavorable for regulation and new developers to learn. For
> example, the PR title should be limited to the words [Fix], [Feature], etc. The
> first letter of words should be capitalized. We should also add words such
> as [Hotfix] including some simple repairs. I would like to ask your opinion.
>
> Best wish,
> Caican Cai
>

Re: Specifications about PR

Posted by caican cai <ca...@gmail.com>.

Yes, I am also thinking about influencing the enthusiasm of developers. At
present, we can try the second point first, because there are not many
active people in the community at present, and it is still within control.

Yuepeng Pan <pa...@apache.org> 于2024年1月8日周一 11:56写道：

> Hi,
>
>     cancai. Thank you for your attention on this section.
>     In my limited read, This may require the following limitations.
> Perhaps we have to make some necessary trade-off.
>     - The plugin that uses the commit header format verification will fail
> to verify ci as long as it does not conform to the format.
>             As far as I know, pravega[1] currently uses this strategy, but
> I'm a bit worried that overly complex or strict restrictions may affect the
> enthusiasm of sharers
>     - Committers adheres to these rules[2] during the review and merge
> operations to ensure reasonable formatting.
>     Looking forward to more ideas about it~
>
>
>
>
>
> [1] https://github.com/pravega/pravega
> [2]
> https://streampark.apache.org/community/submit_guide/code_style_and_quality_guide#1-pull-requests--changes-rule
>
>
> Best,
> Roc.
>
> At 2024-01-06 20:21:05, "caican cai" <ca...@gmail.com> wrote:
> >Hello everyone, since joining the Streampark community, I have observed
> >that PR submissions in the Streampark community are very irregular, which
> >is very unfavorable for regulation and new developers to learn. For
> >example, the PR title should be limited to the words [Fix], [Feature],
> etc. The
> >first letter of words should be capitalized. We should also add words such
> >as [Hotfix] including some simple repairs. I would like to ask your
> opinion.
> >
> >Best wish,
> >Caican Cai
>

Re:Specifications about PR

Posted by Yuepeng Pan <pa...@apache.org>.

Hi,

    cancai. Thank you for your attention on this section.
    In my limited read, This may require the following limitations. Perhaps we have to make some necessary trade-off.
    - The plugin that uses the commit header format verification will fail to verify ci as long as it does not conform to the format. 
            As far as I know, pravega[1] currently uses this strategy, but I'm a bit worried that overly complex or strict restrictions may affect the enthusiasm of sharers
    - Committers adheres to these rules[2] during the review and merge operations to ensure reasonable formatting.
    Looking forward to more ideas about it~





[1] https://github.com/pravega/pravega
[2] https://streampark.apache.org/community/submit_guide/code_style_and_quality_guide#1-pull-requests--changes-rule


Best, 
Roc.

At 2024-01-06 20:21:05, "caican cai" <ca...@gmail.com> wrote:
>Hello everyone, since joining the Streampark community, I have observed
>that PR submissions in the Streampark community are very irregular, which
>is very unfavorable for regulation and new developers to learn. For
>example, the PR title should be limited to the words [Fix], [Feature], etc. The
>first letter of words should be capitalized. We should also add words such
>as [Hotfix] including some simple repairs. I would like to ask your opinion.
>
>Best wish,
>Caican Cai