@@ -39,11 +39,10 @@ well using the Git development process.
39
39
40
40
It is * expected* that what you send will need several rounds of
41
41
reviews and discussions. If you are not sure at all about a patch you
42
- can put "[ GSoC RFC/PATCH] " or "[ Outreachy RFC/PATCH] ", depending on
43
- the mentoring program you are applying for, at the beginning of its
44
- subject.
42
+ can mark it as RFC in the subject. See [ section below] ( #use-a-tag-like-gsoc-outreachy-etc-in-your-subject )
43
+ about how to mark patches as RFC.
45
44
46
- Consider
[ a sample email thread
] ( http ://public-inbox.org/git/[email protected] /T/#u) ,
45
+ Consider
[ a sample email thread
] ( https ://public-inbox.org/git/[email protected] /T/#u) ,
47
46
which shows how a developer proposed a change and a patch to implement
48
47
it. The problem being solved, the design of the proposed solution,
49
48
and the implementation of that design were all reviewed and discussed,
@@ -62,7 +61,7 @@ To complete a microproject, you will have to go through approximately
62
61
the following steps:
63
62
64
63
* Download the source code: clone the repository using the
65
- [ Git via Git] ( http ://git-scm.com/downloads) instructions and read
64
+ [ Git via Git] ( https ://git-scm.com/downloads) instructions and read
66
65
the ` README ` file.
67
66
68
67
* Build the source code: this is described in the file ` INSTALL ` .
@@ -75,7 +74,7 @@ the following steps:
75
74
described in ` Documentation/SubmittingPatches ` . A more detailed
76
75
step-by-step guide could be found in [ ` Documentation/MyFirstContribution.txt ` ] ( https://git-scm.com/docs/MyFirstContribution ) .
77
76
78
- * The "[ Hacking Git] ( https://git.github.io /Hacking-Git/) " page
77
+ * The "[ Hacking Git] ( /Hacking-Git/ ) " page
79
78
could also serve as a handy resource. It points to resources
80
79
on various topics related to working on Git.
81
80
@@ -98,15 +97,17 @@ the following steps:
98
97
99
98
* Commit your change. Surprise: we use Git for that, so you will need
100
99
to gain at least
101
- [ a basic familiarity] ( http ://git-scm.com/documentation ) with using
100
+ [ a basic familiarity] ( https ://git-scm.com/docs ) with using
102
101
Git. Make sure to write a good commit message that explains the
103
102
reason for the change and any ramifications. You can find information
104
103
on writing a good commit message in the
105
104
[ "Describe your changes well" section of the ` SubmittingPatches ` document] ( https://git-scm.com/docs/SubmittingPatches#describe-changes ) .
106
105
Remember to make sure
107
106
that you agree with our "Developer's Certificate of Origin" (whose
108
107
text is contained in ` Documentation/SubmittingPatches ` ), and to
109
- signify your agreement by adding a ` Signed-off-by ` line.
108
+ signify your agreement by adding a ` Signed-off-by ` line. Instructions
109
+ on how to add the sign-off is covered in the ` SubmittingPatches `
110
+ document.
110
111
111
112
* * Optional, but recommended:*
112
113
With an account at GitHub, you can use GitHub CI to test your changes
@@ -125,8 +126,8 @@ the following steps:
125
126
126
127
If a branch did not pass all test cases then it is marked with a red cross. In
127
128
that case you can click on the failing job and navigate to
128
- " ci/run-build-and-tests.sh" and/or \
129
- " ci/print-test-failures.sh" . You can also
129
+ ` ci/run-build-and-tests.sh ` and/or \
130
+ ` ci/print-test-failures.sh ` . You can also
130
131
download "Artifacts" which are tarred (or zipped) archives with test data
131
132
relevant for debugging. Fix the problem and push your fix to your GitHub fork.
132
133
This will trigger a new CI build. Ensure all tests pass.
@@ -186,7 +187,7 @@ of them.
186
187
187
188
In general it's a good idea to check on the mailing list archive
188
189
([ lore.kernel.org] ( https://lore.kernel.org/git/ ) and
189
- [ Public Inbox] ( http ://public-inbox.org/git/) are your friends) what
190
+ [ Public Inbox] ( https ://public-inbox.org/git/) are your friends) what
190
191
other GSoC or Outreachy applicants attempting a microproject have
191
192
already been told this year or any previous year, as hopefully it will
192
193
help you avoid some mistakes. As some microproject ideas haven't
@@ -372,11 +373,8 @@ tell us about your skills, interests, experience, background,
372
373
etc. Feel free to tell us what you want about yourself if you wish
373
374
though.
374
375
375
- ### Specify the mentoring program in the subject
376
-
377
- But please, make it clear that you are interested in a specific
378
- mentoring program and use the right tag, like "[ GSoC] ", "[ Outreachy] ",
379
- etc at the beginning of the subject of your emails.
376
+ Make sure to specify your mentoring program clearly as
377
+ [ suggested below] ( #use-a-tag-like-gsoc-outreachy-etc-in-your-subject ) .
380
378
381
379
### Thoroughly check your eligibility in the program
382
380
@@ -483,6 +481,27 @@ other applicants or contributors participating in GSoC or Outreachy
483
481
have been doing in the past, for example what kind of microproject
484
482
they have chosen, how their proposal looked like, etc.
485
483
484
+ If you're using ` format-patch ` for sending your patches to the mailing list,
485
+ you can add this tag as follows:
486
+
487
+ ```
488
+ git format-patch --subject-prefix='GSoC PATCH' <other-arguments>
489
+
490
+ (or)
491
+
492
+ git format-patch --subject-prefix='Outreachy PATCH' <other-arguments>
493
+ ```
494
+
495
+ If you want to mark your patch as RFC, use
496
+
497
+ ```
498
+ git format-patch --rfc --subject-prefix='GSoC PATCH' <other-arguments>
499
+
500
+ (or)
501
+
502
+ git format-patch --rfc --subject-prefix='Outreachy PATCH' <other-arguments>
503
+ ```
504
+
486
505
### Reply inline
487
506
488
507
Many people these days use the "top posting" posting style, but we
0 commit comments