Subject: Developers of Sympa
List archive
- From: IKEDA Soji <address@concealed>
- To: Adam Bernstein <address@concealed>
- Cc: address@concealed
- Subject: Re: [devel@sympa] etiquette for PRs
- Date: Thu, 4 Jul 2024 21:40:23 +0900
Hi Adam.
> 2024/06/28 8:33、Adam Bernstein <address@concealed>のメール:
>
> Soji et al. -
>
> We've got a big list of fixes and improvements to submit, and have already
> done a couple, but I want to be sure I'm doing things the best possible way
> to make things easiest for you. I'm just learning the modern development
> and Github process, so this is probably all very basic and possibly
> annoying, but I'm trying to be good!
>
> So a couple of questions:
>
> 1. If we have a PR to submit, should we create an issue first, or just go
> straight to the PR?
There are no specific rules. Since Sympa's recent release notes are primarily
based on the PRs, Issues would not be mandatory. But if you anticipate that
the changes that your PR proposes are controversial, you might want to submit
an Issue for discussion in advance.
> 2. I know the PR should be from a custom branch on my own fork of the sympa
> repo, but am I correct that each PR should also be *on its own new branch*
> within my fork? Or should they all just be separate commits within the same
> branch? Or does that matter at all?
As an absolute rule, every PR should have a unique name of branch in your
fork.
Those names should not only be unique, they should not be reused in the other
PRs in the future.
> 3. And finally... anything other tips you want to provide, or comments on
> things I did badly on my previous PR
> (https://github.com/sympa-community/sympa/pull/1849)?
What the PR is intended to be should be stated clearly in its initial
comment. However the PR you presented has a link to the original discussion
and there is no problem.
And, generally speaking, multiple changes should not be included in a single
PR,
e.g. multiple bug fixes, multiple feature additions.
Thank you for your contributions!
> Thanks much for your time!
>
> adam
>
> --
> Adam Bernstein (he/him)
> Electric Embers Cooperative
> Handcrafted hosting, powering the fires of change
> electricembers.coop
> (415) 992-6916
- Re: [devel@sympa] etiquette for PRs, IKEDA Soji, 07/04/2024
Archive powered by MHonArc 2.6.19+.