Re: [PATCH] git-gui: add a readme

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 05/10/19 12:51PM, Bert Wesarg wrote:
> On Sat, Oct 5, 2019 at 12:10 AM Pratyush Yadav <me@xxxxxxxxxxxxxxxxx> wrote:
> > +# Contributing
> > +
> > +The project is currently maintained by Pratyush Yadav over at
> > +https://github.com/prati0100/git-gui. Even though the project is hosted at
> > +GitHub, the development does not happen over GitHub Issues and Pull Requests.
> > +Instead, an email based workflow is used. The git mailing list
> > +[git@xxxxxxxxxxxxxxx](mailto:git@xxxxxxxxxxxxxxx) is where the patches are
> > +discussed and reviewed.
> > +
> > +More information about the git mailing list and instructions to subscribe can
> > +be found [here](https://git.wiki.kernel.org/index.php/GitCommunity).
> > +
> > +## Sending your changes
> > +
> > +Since the development happens over email, you need to send in your commits in
> > +text format. Commits can be converted to emails via the two tools provided by
> > +git: `git-send-email` and `git-format-patch`.
> > +
> > +If you are sending multiple patches, it is recommended to include a cover
> > +letter. A cover letter is an email explaining in brief what the series is
> > +supposed to do. A cover letter template can be generated by passing
> > +`--cover-letter` to `git-format-patch`.
> > +
> > +After you send your patches, you might get a review suggesting some changes.
> > +Make those changes, and re-send your patch(es) in reply to the first patch of
> > +your initial version. Also please mention the version of the patch. This can be
> > +done by passing `-v X` to `git-format-patch`, where 'X' is the version number
> > +of the patch(es).
> > +
> > +### Using git-send-email
> > +
> > +You can use `git-send-email` to send patches via email. A pretty good guide to
> > +configuring and using `git-send-email` can be found
> > +[here](https://www.freedesktop.org/wiki/Software/PulseAudio/HowToUseGitSendEmail/)
> > +
> > +### Using your email client
> > +
> > +If your email client supports sending mbox format emails, you can use
> > +`git-format-patch` to get an mbox file for each commit, and then send them. If
> > +there is more than one patch in the series, then all patches after the first
> > +patch (or the cover letter) need to be sent as replies to the first.
> > +`git-send-email` does this by default.
> > +
> 
> Junio mentioned (at least?) once [1], that using only git-send-email
> is not a good workflow. Instead one should use git-format-patch to
> generate the patches, audit them. and then use git-send-email. I
> second this.
> 
> Please switch these two sections to encompass this.

Thanks for pointing it out. Will fix.
 
> Thanks.
> 
> Bert
> 
> [1] https://public-inbox.org/git/xmqqh9n241el.fsf@xxxxxxxxxxxxxxxxxxxxxxxxxxx/

-- 
Regards,
Pratyush Yadav



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux