> On May 17, 2020, at 3:42 AM, Abhishek Kumar <abhishekkumar8222@xxxxxxxxx> wrote: > > Hello Kenneth, Hello. Thanks for taking the time to assist me. I am gradually working through all the replies. > > On Sat, May 16, 2020 at 10:13:38PM -0400, Kenneth Lorber wrote: >> From: Kenneth Lorber <keni@xxxxxxx> >> >> This started as an effort to understand this section of config.txt: >> When inventing new variables for use in your own tool, make sure their >> names do not conflict with those that are used by Git itself and >> other popular tools, and describe them in your documentation. >> and grew from there. >> >> I don't expect this to be adopted as is, but I've found it much easier >> to discuss something concrete rather than an abstract "this is >> incomplete" or "this is hard to find." >> >> Cut from master. >> >> keni (6): >> Tell the glossary about core.hooksPath >> Add bit on extending git to Hacking Git >> Add namespace collision avoidance guidelines file >> Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt >> Tell config.txt about NAMESPACE COLLISIONS >> Add NAMESPACE COLLISIONS reference to Hacking Git >> >> Documentation/config.txt | 4 +- >> Documentation/gitrepository-layout.txt | 2 + >> Documentation/glossary-content.txt | 10 ++- >> .../technical/namespace-collisions.txt | 86 +++++++++++++++++++ >> Documentation/user-manual.txt | 9 ++ >> 5 files changed, 106 insertions(+), 5 deletions(-) >> create mode 100644 Documentation/technical/namespace-collisions.txt >> >> -- >> 2.17.1 >> > > Some general notes about your patch series: > > 1. Conventionally, we prefix the first line with "area: " where the area > is a filename or identifier for general area of the code being modified. > It's customary to start the remainder of the first line after "area: " > with a lower-case letter. > > For example, your commit titles could have been: > - doc: tell the glossary about core.hooksPath > - doc: add bit on extending git to hacking Git > > and so on. > > Check out SubmittingPatches for more information. Got it. I was working from MyFirstContribution.txt which says only: "Start the commit with a 50-column or less subject line, including the name of the component you're working on". If this is a common mistake, perhaps I should take a shot at expanding this a bit? > > 2. We generally don't have a line like in our patches: > >> From Kenneth Lorber <keni@xxxxxxx> That's odd. It's not in the raw 0000-cover-letter.patch file. In response to a comment in another email I've been tweaking both config sendemail.* and my system mailer config and I can't reproduce it (although I see it in a test message from a couple days ago). Hopefully that means it's fixed. > > Between the author information and the signed-off-by, it's redundant. > > 3. You could probably join the patches 3 to 6 together. Or maybe > introduce namespace-collisions.txt in third patch and add references in > all other files in a new, fourth patch. I split it out because 6 deepends on 3, but also conflicts with 2 if 3 is rejected. I have no objections to this change once the dust settles but I'd prefer not to reorganize things until then. If you feel strongly the other way I'll change it now. > > Thanks for the contribution! You're welcome. > > Regards > Abhishek
