Message ID | 20250319170244.32912-1-jayatheerthkulkarni2005@gmail.com (mailing list archive) |
---|---|
State | New |
Headers | show |
Series | [GSOC,v2] Remove outdated mentoring mailing list reference | expand |
K Jayatheerth <jayatheerthkulkarni2005@gmail.com> writes: > Subject: Re: [GSOC][PATCH v2] Remove outdated mentoring mailing list reference [Documentation/SubmittingPatches] The first line of the commit message should be a short description (50 characters is the soft limit, see DISCUSSION in linkgit:git-commit[1]), and should skip the full stop. It is also conventional in most cases to prefix the first line with "area: " where the area is a filename or identifier for the general area of the code being modified, e.g. * doc: clarify distinction between sign-off and pgp-signing * githooks.txt: improve the intro section If in doubt which identifier to use, run `git log --no-merges` on the files you are modifying to see the current conventions. > and clarify tutorial prerequisites Do not do this. What you have on the e-mail "Subject:" line is the first paragraph (whose definition is block of text delineated by blank lines) of the commit log message, and the first paratraph in the body of a patch e-mail is the second paragraph. You do not start your second paragraph at half-sentence, as if it were a continuation of an incomplete previous sentence.
On Fri, Mar 21, 2025 at 4:06 PM Junio C Hamano <gitster@pobox.com> wrote: > > K Jayatheerth <jayatheerthkulkarni2005@gmail.com> writes: > > > Subject: Re: [GSOC][PATCH v2] Remove outdated mentoring mailing list reference > > [Documentation/SubmittingPatches] > > The first line of the commit message should be a short description (50 > characters is the soft limit, see DISCUSSION in linkgit:git-commit[1]), > and should skip the full stop. It is also conventional in most cases to > prefix the first line with "area: " where the area is a filename or > identifier for the general area of the code being modified, e.g. > Went through the discussion > * doc: clarify distinction between sign-off and pgp-signing > * githooks.txt: improve the intro section > > If in doubt which identifier to use, run `git log --no-merges` on the > files you are modifying to see the current conventions. > > > and clarify tutorial prerequisites > > Do not do this. What you have on the e-mail "Subject:" line is the > first paragraph (whose definition is block of text delineated by > blank lines) of the commit log message, and the first paratraph in > the body of a patch e-mail is the second paragraph. You do not > start your second paragraph at half-sentence, as if it were a > continuation of an incomplete previous sentence. > Thank you for the feedback, I will make sure not to repeat them in the further patches -Jay
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc index afcf4b46c1..7b856be41e 100644 --- a/Documentation/MyFirstContribution.adoc +++ b/Documentation/MyFirstContribution.adoc @@ -13,6 +13,7 @@ the Git tree, sending it for review, and making changes based on comments. This tutorial assumes you're already fairly familiar with using Git to manage source code. The Git workflow steps will largely remain unexplained. +This tutorial also assumes you know/understand C programming. [[related-reading]] === Related Reading @@ -40,13 +41,6 @@ the list by sending an email to <git+subscribe@vger.kernel.org> The https://lore.kernel.org/git[archive] of this mailing list is available to view in a browser. -==== https://groups.google.com/forum/#!forum/git-mentoring[git-mentoring@googlegroups.com] - -This mailing list is targeted to new contributors and was created as a place to -post questions and receive answers outside of the public eye of the main list. -Veteran contributors who are especially interested in helping mentor newcomers -are present on the list. In order to avoid search indexers, group membership is -required to view messages; anyone can join and no approval is required. ==== https://web.libera.chat/#git-devel[#git-devel] on Libera Chat
and clarify tutorial prerequisites Signed-off-by: K Jayatheerth <jayatheerthkulkarni2005@gmail.com> --- Documentation/MyFirstContribution.adoc | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-)