Re: DOC: Update documentation / comments to be gender neutral
Thanks for the suggestion, Tim. That commit message sounds good to me. On Sun, Jul 26, 2020 at 11:49 AM Tim Düsterhus wrote: > Jackie, > > Am 26.07.20 um 18:36 schrieb Jackie Tapia: > > I've attached an updated patch. > > > Thank you, the Diff LGTM now (however I did not check whether you missed > any gendered phrasing). > > Unfortunately it appears that you missed by remark regarding the missing > commit message body. > > Please make sure to always use a single line commit title *plus* at > least a single line commit message body. If the title wraps within the > generated patch files it is probably too long. > > Based off your patch and existing commit message, may I suggest the > following? > > --- > DOC: Use gender neutral language > > This patch updates the documentation files and code comments to avoid > the use of gender specific phrasing in favor of "they" or "it". > --- > > Best regards > Tim Düsterhus > > -- Jackie Tapia Platform Software Engineer Sprout Social sproutsocial.com Pronouns <http://www.the519.org/education-training/training-resources/our-resources/creating-authentic-spaces/gender-specific-and-gender-neutral-pronouns>: She/Her/Hers 0001-DOC-Use-gender-neutral-language.patch Description: Binary data
Re: DOC: Update documentation / comments to be gender neutral
I've attached an updated patch. Thanks! On Sun, Jul 26, 2020 at 10:58 AM Jackie Tapia wrote: > Thank you for the feedback! I'll make those changes. > > On Thu, Jul 23, 2020 at 2:14 AM Tim Düsterhus wrote: > >> Jackie, >> >> First: I'm a community contributor, so my review might not necessarily >> reflect that of the HAProxy project. I'm also not a native English >> speaker. >> >> Regarding your patch I have a few comments: >> >> From your PR message: >> >> > Also, remove some trailing whitespaces from the files modified for >> funsies. >> >> I disagree with this change. This makes the patch larger than it needs >> to be and it distracts from the important parts of it. If anything it >> should become a dedicated patch that is separately committed. >> >> Regarding your commit messages: >> >> Please have a look at the CONTRIBUTING file you modified. Commit >> messages need to be prefixed with a "tag" ("DOC:" would probably be >> appropriate) and also contain a body: >> >> >As a rule of thumb, your patch MUST NEVER be made only of a subject >> line, >> >it *must* contain a description. Even one or two lines, or indicating >> >whether a backport is desired or not. It turns out that single-line >> commits >> >are so rare in the Git world that they require special manual (hence >> >painful) handling when they are backported, and at least for this >> reason >> >it's important to keep this in mind. >> >> ( >> https://github.com/haproxy/haproxy/blob/f1ea47d8960730c79cc71fc634b3d7e5909d5683/CONTRIBUTING#L562-L567 >> ) >> >> Then to the patch itself: >> >> - It must not modify the license files doc/lgpl.txt and doc/gpl.txt, >> because they are standard license texts: >> https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html >> - In lua.txt it now reads "They just works carefully". I believe it >> should be "They just work carefully". >> - In proxy-protocol.txt it now reads "to hide it's activities". I >> believe it should be "to hide its activities". >> >> Best regards >> Tim Düsterhus >> > > > -- > > Jackie Tapia > > Platform Software Engineer > > Sprout Social > > sproutsocial.com > > > > Pronouns > <http://www.the519.org/education-training/training-resources/our-resources/creating-authentic-spaces/gender-specific-and-gender-neutral-pronouns>: > She/Her/Hers > -- Jackie Tapia Platform Software Engineer Sprout Social sproutsocial.com Pronouns <http://www.the519.org/education-training/training-resources/our-resources/creating-authentic-spaces/gender-specific-and-gender-neutral-pronouns>: She/Her/Hers 0001-DOC-update-documentation-comments-to-be-gender-neutr.patch Description: Binary data
Re: DOC: Update documentation / comments to be gender neutral
Thank you for the feedback! I'll make those changes. On Thu, Jul 23, 2020 at 2:14 AM Tim Düsterhus wrote: > Jackie, > > First: I'm a community contributor, so my review might not necessarily > reflect that of the HAProxy project. I'm also not a native English speaker. > > Regarding your patch I have a few comments: > > From your PR message: > > > Also, remove some trailing whitespaces from the files modified for > funsies. > > I disagree with this change. This makes the patch larger than it needs > to be and it distracts from the important parts of it. If anything it > should become a dedicated patch that is separately committed. > > Regarding your commit messages: > > Please have a look at the CONTRIBUTING file you modified. Commit > messages need to be prefixed with a "tag" ("DOC:" would probably be > appropriate) and also contain a body: > > >As a rule of thumb, your patch MUST NEVER be made only of a subject > line, > >it *must* contain a description. Even one or two lines, or indicating > >whether a backport is desired or not. It turns out that single-line > commits > >are so rare in the Git world that they require special manual (hence > >painful) handling when they are backported, and at least for this > reason > >it's important to keep this in mind. > > ( > https://github.com/haproxy/haproxy/blob/f1ea47d8960730c79cc71fc634b3d7e5909d5683/CONTRIBUTING#L562-L567 > ) > > Then to the patch itself: > > - It must not modify the license files doc/lgpl.txt and doc/gpl.txt, > because they are standard license texts: > https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html > - In lua.txt it now reads "They just works carefully". I believe it > should be "They just work carefully". > - In proxy-protocol.txt it now reads "to hide it's activities". I > believe it should be "to hide its activities". > > Best regards > Tim Düsterhus > -- Jackie Tapia Platform Software Engineer Sprout Social sproutsocial.com Pronouns <http://www.the519.org/education-training/training-resources/our-resources/creating-authentic-spaces/gender-specific-and-gender-neutral-pronouns>: She/Her/Hers
DOC: Update documentation / comments to be gender neutral
-- Jackie Tapia Platform Software Engineer Sprout Social sproutsocial.com Pronouns <http://www.the519.org/education-training/training-resources/our-resources/creating-authentic-spaces/gender-specific-and-gender-neutral-pronouns>: She/Her/Hers 0002-Update-contributing-doc.patch Description: Binary data 0001-Update-docs-comments-to-be-more-inclusive-of-all-gen.patch Description: Binary data