From 912e386d4eb8ab6aac80091e3cc7197e86d07177 Mon Sep 17 00:00:00 2001 From: Kaartic Sivaraam Date: Sun, 30 Mar 2025 23:53:14 +0530 Subject: [PATCH 1/4] Microproject-info: consolidate info about using appropriate e-mail subjects This is a follow up of PR #756. There were other parts of the document that also referred to the metoring program tag. Consolidate them in one place and refer to it from other documents to avoid confusion. --- General-Microproject-Information.md | 33 ++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/General-Microproject-Information.md b/General-Microproject-Information.md index 67e00e590..4f0df18c6 100644 --- a/General-Microproject-Information.md +++ b/General-Microproject-Information.md @@ -39,9 +39,8 @@ well using the Git development process. It is *expected* that what you send will need several rounds of reviews and discussions. If you are not sure at all about a patch you -can put "[GSoC RFC/PATCH]" or "[Outreachy RFC/PATCH]", depending on -the mentoring program you are applying for, at the beginning of its -subject. +can mark it as RFC in the subject. See [section below](#use-a-tag-like-gsoc-outreachy-etc-in-your-subject) +about how to mark patches as RFC. Consider [a sample email thread](http://public-inbox.org/git/1386590745-4412-1-git-send-email-t.gummerer@gmail.com/T/#u), which shows how a developer proposed a change and a patch to implement @@ -372,11 +371,8 @@ tell us about your skills, interests, experience, background, etc. Feel free to tell us what you want about yourself if you wish though. -### Specify the mentoring program in the subject - -But please, make it clear that you are interested in a specific -mentoring program and use the right tag, like "[GSoC]", "[Outreachy]", -etc at the beginning of the subject of your emails. +Make sure to specify your mentoring program clearly as +[suggested below](#use-a-tag-like-gsoc-outreachy-etc-in-your-subject). ### Thoroughly check your eligibility in the program @@ -483,6 +479,27 @@ other applicants or contributors participating in GSoC or Outreachy have been doing in the past, for example what kind of microproject they have chosen, how their proposal looked like, etc. +If you're using `format-patch` for sending your patches to the mailing list, +you can add this tag as follows: + +``` +git format-patch --subject-prefix='GSoC PATCH' + +(or) + +git format-patch --subject-prefix='Outreachy PATCH' +``` + +If you want to mark your patch as RFC, use + +``` +git format-patch --rfc --subject-prefix='GSoC PATCH' + +(or) + +git format-patch --rfc --subject-prefix='Outreachy PATCH' +``` + ### Reply inline Many people these days use the "top posting" posting style, but we From 674ee595a232594a5bc0a4aa4c2e88568fa067d7 Mon Sep 17 00:00:00 2001 From: Kaartic Sivaraam Date: Mon, 31 Mar 2025 00:00:45 +0530 Subject: [PATCH 2/4] Microproject-info: some link corrections - Change HTTP to HTTPS for sites that are already redirecting HTTP to HTTPS. - Avoid hardcoding git.github.io and use a local reference instead. --- General-Microproject-Information.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/General-Microproject-Information.md b/General-Microproject-Information.md index 4f0df18c6..0ab60c0e3 100644 --- a/General-Microproject-Information.md +++ b/General-Microproject-Information.md @@ -42,7 +42,7 @@ reviews and discussions. If you are not sure at all about a patch you can mark it as RFC in the subject. See [section below](#use-a-tag-like-gsoc-outreachy-etc-in-your-subject) about how to mark patches as RFC. -Consider [a sample email thread](http://public-inbox.org/git/1386590745-4412-1-git-send-email-t.gummerer@gmail.com/T/#u), +Consider [a sample email thread](https://public-inbox.org/git/1386590745-4412-1-git-send-email-t.gummerer@gmail.com/T/#u), which shows how a developer proposed a change and a patch to implement it. The problem being solved, the design of the proposed solution, and the implementation of that design were all reviewed and discussed, @@ -61,7 +61,7 @@ To complete a microproject, you will have to go through approximately the following steps: * Download the source code: clone the repository using the - [Git via Git](http://git-scm.com/downloads) instructions and read + [Git via Git](https://git-scm.com/downloads) instructions and read the `README` file. * Build the source code: this is described in the file `INSTALL`. @@ -74,7 +74,7 @@ the following steps: described in `Documentation/SubmittingPatches`. A more detailed step-by-step guide could be found in [`Documentation/MyFirstContribution.txt`](https://git-scm.com/docs/MyFirstContribution). -* The "[Hacking Git](https://git.github.io/Hacking-Git/)" page +* The "[Hacking Git](/Hacking-Git/)" page could also serve as a handy resource. It points to resources on various topics related to working on Git. @@ -97,7 +97,7 @@ the following steps: * Commit your change. Surprise: we use Git for that, so you will need to gain at least - [a basic familiarity](http://git-scm.com/documentation) with using + [a basic familiarity](https://git-scm.com/docs) with using Git. Make sure to write a good commit message that explains the reason for the change and any ramifications. You can find information on writing a good commit message in the @@ -185,7 +185,7 @@ of them. In general it's a good idea to check on the mailing list archive ([lore.kernel.org](https://lore.kernel.org/git/) and -[Public Inbox](http://public-inbox.org/git/) are your friends) what +[Public Inbox](https://public-inbox.org/git/) are your friends) what other GSoC or Outreachy applicants attempting a microproject have already been told this year or any previous year, as hopefully it will help you avoid some mistakes. As some microproject ideas haven't From 19c81e766e8fdb324f5c46dba5c3e2f4e4708363 Mon Sep 17 00:00:00 2001 From: Kaartic Sivaraam Date: Mon, 31 Mar 2025 00:02:05 +0530 Subject: [PATCH 3/4] Microproject-info: include info about the guide that describes adding sign-off --- General-Microproject-Information.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/General-Microproject-Information.md b/General-Microproject-Information.md index 0ab60c0e3..93d63617e 100644 --- a/General-Microproject-Information.md +++ b/General-Microproject-Information.md @@ -105,7 +105,9 @@ the following steps: Remember to make sure that you agree with our "Developer's Certificate of Origin" (whose text is contained in `Documentation/SubmittingPatches`), and to - signify your agreement by adding a `Signed-off-by` line. + signify your agreement by adding a `Signed-off-by` line. Instructions + on how to add the sign-off is covered in the `SubmittingPatches` + document. * *Optional, but recommended:* With an account at GitHub, you can use GitHub CI to test your changes From 976acd385db53165e516771e687a6915d03c140d Mon Sep 17 00:00:00 2001 From: Kaartic Sivaraam Date: Mon, 31 Mar 2025 00:03:52 +0530 Subject: [PATCH 4/4] Microproject-info: monospace for the sake of better readability --- General-Microproject-Information.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/General-Microproject-Information.md b/General-Microproject-Information.md index 93d63617e..ef880a64f 100644 --- a/General-Microproject-Information.md +++ b/General-Microproject-Information.md @@ -126,8 +126,8 @@ the following steps: If a branch did not pass all test cases then it is marked with a red cross. In that case you can click on the failing job and navigate to - "ci/run-build-and-tests.sh" and/or \ - "ci/print-test-failures.sh". You can also + `ci/run-build-and-tests.sh` and/or \ + `ci/print-test-failures.sh`. You can also download "Artifacts" which are tarred (or zipped) archives with test data relevant for debugging. Fix the problem and push your fix to your GitHub fork. This will trigger a new CI build. Ensure all tests pass.