RFR: Clearly state that users should create branch [v2]

Magnus Ihse Bursie ihse at openjdk.org
Mon Jan 23 11:20:35 UTC 2023


On Tue, 17 Jan 2023 21:59:00 GMT, Magnus Ihse Bursie <ihse at openjdk.org> wrote:

>> A recent PR submission to the JDK made me aware that the guide does not strongly enough emphasize the importance of creating a separate branch. 
>> 
>> (If you do put your changes directly in `master`, the Skara bots will put up harsh warnings, which is not a nice way to welcome someone who has tried to do everything right, including reading the guide)
>
> Magnus Ihse Bursie has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Fix typo
>   
>   Co-authored-by: Alexey Ivanov <alexey.ivanov at oracle.com>

If you have ever tried this, you'd discover what "messy and complicated" means. Your HEAD will diverge from the HEAD of upstream, which will cause a wide variety of different issues depending on what you are trying to do with your fork. I could not reasonably list them all, nor will it serve a purpose since it will only distract from the point which is "don't do this".

I still think the recommendation is a "should", not a "must". It is not that things do not work if you do otherwise, it is just that you will make things needlessly complicated for yourself. Something that is a "must" is more like the JBS/PR title match, there are no room for alternatives there, no matter how savvy you are.

But sure, I can try to rewrite this to sound less subjective, while still keeping out the gory details (which do not really matter at this point).

-------------

PR: https://git.openjdk.org/guide/pull/94


More information about the guide-dev mailing list