Skip to content

Commit 912e386

Browse files
committed
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.
1 parent 5253a9d commit 912e386

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

General-Microproject-Information.md

+25-8
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ well using the Git development process.
3939

4040
It is *expected* that what you send will need several rounds of
4141
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.
4544

4645
Consider [a sample email thread](http://public-inbox.org/git/[email protected]/T/#u),
4746
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,
372371
etc. Feel free to tell us what you want about yourself if you wish
373372
though.
374373

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.
374+
Make sure to specify your mentoring program clearly as
375+
[suggested below](#use-a-tag-like-gsoc-outreachy-etc-in-your-subject).
380376

381377
### Thoroughly check your eligibility in the program
382378

@@ -483,6 +479,27 @@ other applicants or contributors participating in GSoC or Outreachy
483479
have been doing in the past, for example what kind of microproject
484480
they have chosen, how their proposal looked like, etc.
485481

482+
If you're using `format-patch` for sending your patches to the mailing list,
483+
you can add this tag as follows:
484+
485+
```
486+
git format-patch --subject-prefix='GSoC PATCH' <other-arguments>
487+
488+
(or)
489+
490+
git format-patch --subject-prefix='Outreachy PATCH' <other-arguments>
491+
```
492+
493+
If you want to mark your patch as RFC, use
494+
495+
```
496+
git format-patch --rfc --subject-prefix='GSoC PATCH' <other-arguments>
497+
498+
(or)
499+
500+
git format-patch --rfc --subject-prefix='Outreachy PATCH' <other-arguments>
501+
```
502+
486503
### Reply inline
487504

488505
Many people these days use the "top posting" posting style, but we

0 commit comments

Comments
 (0)